Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gispirova authored Jun 10, 2024
1 parent 883daf9 commit 88c228b
Showing 1 changed file with 52 additions and 53 deletions.
105 changes: 52 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,59 @@ This Python implementation uses precomputed distance matrices to optimize calcul
## Getting Started

### Setting up a work environment

#### I. With installing the package

1. Installing the necessary dependencies:


##### Option A: working with Conda

Working with Conda is recommended, but it is not essential. If you choose to work with Conda, these are the steps you need to take:

- Ensure you have Conda installed.

- Download the environment.yml and navigate to the directory of your local/remote machine where the file is located.

- Create a new conda environment with the `environment.yml` file:

```bash
conda env create -f environment.yml
```

- Activate your new conda environment:

```bash
conda activate netmedpy_environment
```

##### Option B: working without Conda

- Ensure the following dependencies are installed before proceeding:

```bash
pip install networkx seaborn matplotlib numpy pandas ray scipy
```

2. Install the package:

```bash
pip install netmedpy
```
3. Download the directory `examples`.

4. Navigate to the directory `examples`:

```bash
cd /user_path_to/examples
```
5. Run the `Basic_example.py` script using Python 3 or higher:

```bash
python Basic_example.py
```
#### I. Without installing the package

1. Ensure you have Python installed.
Expand Down Expand Up @@ -94,59 +146,6 @@ Working with Conda is recommended, but it is not essential. If you choose to wor
```bash
python Basic_example.py
```

#### II. With installing the package

1. Installing the necessary dependencies:


##### Option A: working with Conda

Working with Conda is recommended, but it is not essential. If you choose to work with Conda, these are the steps you need to take:

- Ensure you have Conda installed.

- Download the environment.yml and navigate to the directory of your local/remote machine where the file is located.

- Create a new conda environment with the `environment.yml` file:

```bash
conda env create -f environment.yml
```

- Activate your new conda environment:

```bash
conda activate netmedpy_environment
```

##### Option B: working without Conda

- Ensure the following dependencies are installed before proceeding:

```bash
pip install networkx seaborn matplotlib numpy pandas ray scipy
```

2. Install the package:

```bash
pip install netmedpy
```

3. Download the directory `examples`.

4. Navigate to the directory `examples`:

```bash
cd /user_path_to/examples
```

5. Run the `Basic_example.py` script using Python 3 or higher:

```bash
python Basic_example.py
```

## Examples

Expand Down

0 comments on commit 88c228b

Please sign in to comment.