Including your method in the Environmental Data Science Toolbox is a great way to improve the outreach of your work and support collaborative science.
The toolbox supports a wide range of methods and coding languages — whatever your idea, we’d love to hear about it!
Steps¶
1. Open a GitHub issue¶
Create a GitHub issue using either the notebook idea template (early stage) or the notebook inclusion template (notebook ready to go).
2. Create a standalone repository¶
Create a GitHub repository for your notebook following the naming convention ds-toolbox-notebook-{name} (e.g. ds-toolbox-notebook-bias-correction). Upload your notebook, any necessary supporting files, and a CITATION.cff file.
3. Prepare your notebook¶
Your notebook must include a frontmatter metadata block. Use the template notebook as a starting point, and refer to the notebook metadata guidance for full details on the required fields (title, authors, license, funding, etc.).
4. Add the repository as a submodule¶
Request collaborator access to the toolbox repository by emailing jercar@ceh.ac.uk, then clone the toolbox repo. Inside the methods/ folder, add your repository as a git submodule:
git submodule add {url-of-your-repository}5. Add your notebook to the table of contents¶
Update myst.yml to include your notebook:
- file: methods/ds-toolbox-notebook-{name}/{notebook-filename}.ipynb
title: Your Method Title6. Preview and raise a pull request¶
Run jupyter book start from the repository root to preview the book locally. Once you’re happy with how it looks, push your branch and open a pull request for review.