Skip to content

Commit dcdcc6c

Browse files
committed
Update README.md
1 parent 1b4743a commit dcdcc6c

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,20 @@ A schematic detailing how the HEROS algorithm works is given below:
2929
***
3030
<a id="item-two"></a>
3131
## Installation
32-
HEROS can currently only be installed by cloning this repository. Make sure that you have also installed all prerequisite packages included in requirements.txt prior to running (Note: this list may need updating - so if you get errors, check first that you have necessary packages installed).
32+
HEROS can be installed with pip or by cloning this repository.
3333

34+
### Pip
35+
HEROS can most easily be installed using the following pip command:
36+
```
37+
pip install skheros
38+
```
39+
In order to run the [HEROS_Demo_Notebook](https://github.com/UrbsLab/heros/blob/main/HEROS_Demo_Notebook.ipynb), download it and make sure to set the following notebook parameter to False in order to import HEROS from the above pip installation.
40+
```
41+
load_from_cloned_repo = False
42+
```
3443

3544
### Clone Respository
45+
To install/run HEROS from this cloned repository, run the following commands from the desired folder:
3646
```
3747
git clone --single-branch https://github.com/UrbsLab/heros
3848
cd heros
@@ -62,7 +72,7 @@ Lastly, the fit() method can optionally be passed 'pop_df', a dataframe object,
6272

6373
### Demonstration Notebook
6474
A Jupyter Notebooks has been included to demonstrate how HEROS (and it's functions) can be applied to train, evaluate, and apply models with a wide variety of saved outputs, visualizations and model prediction explanations. We strongly recommend exploring this demonstration notebook to get familiar with HEROS and its capabilities.
65-
* [DEMO Notebook](https://github.com/UrbsLab/heros/blob/main/HEROS_Demo_Notebook.ipynb)
75+
* [HEROS_Demo_Notebook](https://github.com/UrbsLab/heros/blob/main/HEROS_Demo_Notebook.ipynb)
6676

6777
This notebook is currently set up to run by cloning this repository and running the included notebook.
6878

0 commit comments

Comments
 (0)