The materials in this repo document tips and tricks for better, cleaner and more understandable jupyter notebooks. The teaching materials are focussed on using the Jupyter-lab IDE.

The materials have been made available under an MIT license.

All dependencies can be found in binder/environment.yml and are pulled from conda-forge. To run the code locally, we recommend installing miniforge;

miniforge is Free and Open Source Software (FOSS) alternative to Anaconda and miniconda that uses conda-forge as the default channel for packages. It installs both conda and mamba (a drop in replacement for conda) package managers. We recommend mamba for faster resolving of dependencies and installation of packages.

navigating your terminal (or cmd prompt) to the directory containing the repo and issuing the following command:

mamba env create -f binder/environment.yml

Activate the mamba environment using the following command:

mamba activate jupyter-tips

Run Jupyter-lab

jupyter-lab

The examples have been setup to run online in Jupyter notebooks via binder

mybinder.org is a free tier service. If the repo has not been used in a while Binder will need to re-containerise the code repository, and push to BinderHub. This will take several minutes. After that the online environment will be quick to load.

.
├── binder
│   └── environment.yml
├── CHANGELOG.md
├── CITATION.cff
├── LICENSE
├── notebooks
│   ├── 01_linting_notebooks.ipynb
│   └── 02_notebook_to_format.ipynb
└── README.md

• binder/ - contains the environment.yml file (sim) and all dependencies managed via conda, used to set-up the notebooks on Binder.
• notebooks/ contains the Jupyter tips notebooks
• CHANGES.md - changelog with record of notable changes to project between versions.
• CITATION.cff - citation information for the package.
• LICENSE - details of the MIT permissive license of this work.