cookiecutter-hydro 0.1.1

A cookiecutter template for scientific Python projects in the field of hydrology.

Main features

• pixi for dependency and task management in generated projects
• Code quality with ruff, mypy and prettier
• Containerization with Docker
• Development environment with VSCode devcontainers

Quickstart

On your local machine, navigate to the directory in which you want to create a project directory, and run the following two commands:

pip install cookiecutter-hydro
cchydro

Alternatively, install cookiecutter and directly pass the URL to this Github repository to the cookiecutter command:

pip install cookiecutter
cookiecutter https://github.com/zawadzkim/cookiecutter-hydro.git

Create a repository on GitHub, and then run the following commands, replacing <project-name>, with the name that you gave the Github repository and <github_author_handle> with your Github username.

cd <project_name>
git init -b main
git add .
git commit -m "Init commit"
git remote add origin [e-mail]:<github_author_handle>/<project_name>.git
git push -u origin main

Finally, install dependencies and run checks with

pixi install
pixi run all

You are now ready to start development on your project!

Acknowledgements

This project is inspired by Cookiecutter Poetry and Cookiecutter Data Science, and is tailored for use in hydrological research.