Skip to content

Commit a7ae20f

Browse files
committed
readme update
1 parent a08a4ea commit a7ae20f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: README.md

+18
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,21 @@
22
All data used in this study is available in the data folder on this repository. The file named **240_B.txt** is used for the major analysis of this study while the **journal_data.csv** file is used for creating a supplementary table.
33
## Code Availability
44
All code used to generate the figures in this study and all relevant statistics are available in the notebooks folder in the **Figure.ipynb** notebook file.
5+
6+
7+
## Running Notebook
8+
### 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:
10+
`conda env create -f environment.yml`
11+
Once created, then just use the following command to activate your environement.
12+
`conda activate code_availability_env`
13+
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.
14+
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.
15+
16+
### 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:
18+
`pip install -r requirements.txt`
19+
Once this is done running, the notebook should run
20+
21+
### Google Collab
22+
We will be adding a google collab notebook that everyone can use to rerun the code to generate the figures as well in the near future.

0 commit comments

Comments
 (0)