Skip to content

Commit d315e87

Browse files
committed
readme update
1 parent a7ae20f commit d315e87

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

Diff for: README.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,23 @@ All code used to generate the figures in this study and all relevant statistics
66

77
## Running Notebook
88
### Conda
9-
In order to run the notebook, we reccomend first either creating a conda environment using the **environment.yml** file we provide in our dependencies folder. You can create the environment by running the following commands:
9+
In order to run the notebook, we reccomend first either creating a conda environment using the **environment.yml** file we provide in our dependencies folder. You can create the environment by running the following commands:
10+
1011
`conda env create -f environment.yml`
12+
1113
Once created, then just use the following command to activate your environement.
14+
1215
`conda activate code_availability_env`
16+
1317
If you are running the notebook in VSCode, then use the change kernel button to select the code_availability_env as the environment to run the notebook in.
1418
If you are running the notebook in Jupyter Notebook, then just make sure the environment is activated before running calling jupyter notebook to run the notebook.
1519

1620
### Pip
17-
If you do not want to use conda and have some other preference for environments or rather just don't use environments, you can use the requirements.txt file which will allow you to install all of the dependencies as well via pip:
21+
If you do not want to use conda and have some other preference for environments or rather just don't use environments, you can use the requirements.txt file which will allow you to
22+
install all of the dependencies as well via pip:
23+
1824
`pip install -r requirements.txt`
25+
1926
Once this is done running, the notebook should run
2027

2128
### Google Collab

0 commit comments

Comments
 (0)