From 88c228b018182c7d76c14f1e9ce528a9695301a5 Mon Sep 17 00:00:00 2001 From: Gordana Ispirova <166062997+gispirova@users.noreply.github.com> Date: Mon, 10 Jun 2024 15:18:28 -0400 Subject: [PATCH] Update README.md --- README.md | 105 +++++++++++++++++++++++++++--------------------------- 1 file changed, 52 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index 4b70166..c4a7b76 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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