on-demand-downscaling

This repository contains the workflow for the on-demand downscaling project. The on-demand_downscaling directory has the following files:

• A README.md describing the goals of the project, how the notebook is structured and should be run, and some additional information
• The notebook itself, called on_demand_downscaling.ipynb
• A module called helpers.py with helper functions/objects used to set up the widgets used throughout the notebook

Installation

The dependencies used for this repo are managed using the poetry tool. You can review the instructions for how to install it. After doing so, you can set up the virtual environment and the dependencies by running

$ poetry install

You can then enter the environment by running

$ poetry shell

Notebook Startup

Once the virtual environment is set up, you can start a Jupyterlab instance by running

jupyter lab

You can then open the notebook from the left sidebar.

Releasing

Creating a versioned release involves:

1. Incrementing version in pyproject.toml
2. Summarize the changes from the last release in NEWS.md
3. Commit these changes, then tag the release:

git add pyproject.toml NEWS.md
git commit -m "Bump to version X.X.X"
git tag -a -m "X.X.X" X.X.X
git push --follow-tags