Skip to content

FlorisCalkoen/CoastalCodebook

Repository files navigation

Coastal Dynamics Open Codebook

Welcome to the Coastal Dynamics Open Codebook! This project contains interactive exercises that cover material of the Coastal Dynamics Open Textbook as well as a Python package, that is designed for creating interactive questions, complete with a simple grading mechanism.

For more information regarding the course, installation and usage we refer the interested reader to our Jupyterbook, that is available online!

Usage

Detailed instructions for both the notebooks and the package are provided in our Jupyterbook online.

Interactive teaching material

Instructions for running the tutorial notebooks are available here.

Package installation

Install the Python package using pip:

pip install coastal-dynamics

Architecture

Components

architecture

User usage

image

Questions

If you have a question about the installation process or notebooks, feel free to open an issue in the GitHub repository. If that's your first time, have a look at these instructions. We choose to use the GitHub issue-tracker because your fellow students probably have similar problems. We will probably not troubleshoot the tutorial notebooks by email!

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits

This project is created by using open source software only! Many thanks to NUMFocus for supporting and maintaining all these open source initiatives. We used cookiecutter-jupyter-book template as our template for the book structure.