Slides can be found here.

This is not a production or science-ready code. It is only meant to be used as an example code to practice optimisation and play with Python tools. It is modified from a student's coursework project and makes several (well-founded) simplifying assumptions. The code has NOT been validated against known solutions. Do not use this code for research!

First clone this repo from github:

git clone [email protected]:smutch/code_prac_hwsa2021.git
cd code_prac_hwsa2021

Dependencies can be installed using either pip or conda(+pip) depending on your preference.

This code has only been tested with Python 3.9. You can check your verison of python using:

python -V

If you are using an older version then 3.9 then it is strongly recommended that you install it using pyenv or a similar python version management tool.

Once you have Python 3.9, create a new virtualenv using the tool of your choice and activate it e.g.:

python -m venv env
source env/bin/activate

You can then install the code_prac in editable mode, and all its dependencies using:

pip install -e '.[dev]'

Setup a new conda environment with all required dependencies and the code_prac package installed in editable mode using:

conda env create -f environment.yml
conda activate code_prac_hwsa2021
pip install -e '.[dev]'