All analysis code related to the Bison Lab project at Earthshot Institute.

• In terminal/command line, navigate to your preferred software directory and clone this reposity to your local computer

# with SSH key
git clone [email protected]:earthshot-institute/bison-lab.git

# or with username/password
git clone https://github.com/earthshot-institute/bison-lab.git

An Anaconda Python distribution is required as this simplifies the installation. Either Miniconda or Conda are suitable: please follow the conda installation guide.

Once Conda is installed, we can create a conda environment called bison-lab in which we can install all libraries/dependencies for this repository:

conda env create -f environment.yml

Before running any code activate this conda environment:

conda activate bison-lab

The environment can be deactivated with:

conda deactivate

To run code quality tooling on every commit, we need to install the pre-commit Git hook:

pre-commit install

Now on every commit, the hooks configured in the .pre-commit-config.yaml will be executed.

To remove the bison-lab conda environment:

conda env remove -n bison-lab

Run Jupyter from the notebooks directory.

You have the option of using JupyterLab:

jupyter lab

or the "classic" Jupyter notebook:

jupyter notebook notebooks/