From c2cb1f1bbce84c4fed4f83953828359a3b7bbe40 Mon Sep 17 00:00:00 2001 From: Jhabriel Varela Date: Tue, 18 Jun 2024 21:52:09 -0400 Subject: [PATCH] Create install_instructions.md --- install_instructions.md | 63 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 install_instructions.md diff --git a/install_instructions.md b/install_instructions.md new file mode 100644 index 0000000..4236c6f --- /dev/null +++ b/install_instructions.md @@ -0,0 +1,63 @@ +# Running mdestimates within a conda environment + +## Set up a conda environment + +1. Make sure you have Anaconda installed on your computer. +``` +conda list +``` +2. Make sure the default channel is up-to-date +``` +conda update -n base -c defaults conda +``` +3. Add the conda-forge channel (ignore the warning if it is already present) +``` +conda config --add channels conda-forge +``` +4. Create a new conda environment +``` +conda create --name mdenv python=3.9 +``` +5. Activate your environment +``` +conda activate mdenv +``` +6. Install a few important libraries +``` +conda install git jupyter notebook +``` + +## Install quadpy +Unfortunately, `quadpy` is now proprietary. However, we can install the latest open source version. +``` +conda install conda-forge::quadpy==0.16.10 +``` + +## Install PorePy +1. Head to a folder where you wish to clone PorePy, clone it, and checkout commit `67b32246`: +``` +git clone https://github.com/pmgbergen/porepy.git +cd porepy +git fetch --all +git checkout 67b32246 +``` +2. Install PorePy requirements using conda +``` +conda install --file requirements_dev.txt +``` +3. Install PorePy using pip +``` +pip install --user -e . +``` +4. Check your PorePy installation +``` +pytest +``` + +## Install mdestimates +Head to the same folder you've installed PorePy, clone the development version of `mixdim-estimates` and install using pip: +``` +git clone https://github.com/jhabriel/mixdim-estimates.git +cd mixdim-estimates +pip install --user -e . +```