From 8ef6b1af53dea8ce36d13968f3df027064c320f1 Mon Sep 17 00:00:00 2001 From: Christopher Llorracc Carroll <1320319+llorracc@users.noreply.github.com> Date: Tue, 20 Feb 2024 21:43:35 -0500 Subject: [PATCH] Rename requirements.txt to reproduce_requirements.md --- reproduce_requirements.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 reproduce_requirements.md diff --git a/reproduce_requirements.md b/reproduce_requirements.md new file mode 100644 index 0000000..b962cec --- /dev/null +++ b/reproduce_requirements.md @@ -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! \ No newline at end of file