Skip to content

Commit

Permalink
Rename requirements.txt to reproduce_requirements.md
Browse files Browse the repository at this point in the history
  • Loading branch information
llorracc committed Feb 21, 2024
1 parent a09fa3e commit 8ef6b1a
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions reproduce_requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
This file describes the steps necessary to execute the "reproduce".sh file to produce
the main results of this repository.

1. Make sure you have conda, or preferably mamba installed. See either of the links below
for instructions on installing the program of your choice for your machine.
- conda: https://conda.io/projects/conda/en/latest/user-guide/install/index.html
- mamba: https://mamba.readthedocs.io/en/latest/installation.html

2. Once installed, open the terminal so that your present working directory (pwd)
is the one associated with the location of the local version of this repository on
your machine.

3. Navigate to the "binder" folder and make sure a file called "environment.yml"
lives there. Run the following command:
- mamba env create -f environment.yal

Once this command has completed, you are ready to run the reproduce.sh script!

0 comments on commit 8ef6b1a

Please sign in to comment.