📖 Looking for installation instructions, tutorials, troubleshooting, or notebook previews? Visit the online documentation: https://coastal.citg.tudelft.nl/book
Welcome to the Coastal Dynamics Open Codebook. The Coastal Codebook consists of a series of Jupyter notebooks, supplementing the Coastal Dynamics Open Textbook. The interactive exercises of the Coastal Codebook help students interact with and reflect on the textbook material.
The full CoastalCodebook documentation is available online at:
https://coastal.citg.tudelft.nl/book
The documentation is maintained as a Quarto book and serves as the primary source of information for users and contributors. It contains:
Background information on the CoastalCodebook project, including:
- An introduction to the Codebook and its objectives
- The structure of the TU Delft course in which the Codebook is used
- An overview of all notebooks that are part of the Codebook
- Acknowledgements and project background
Practical guidance for working with the CoastalCodebook materials:
- Installation instructions – a step-by-step guide for setting up the coastal computing environment
- Getting started – guidance for running the notebooks in JupyterLab after installation
- Troubleshooting – information on how to report problems, ask questions, and track issue resolution
- Building the book – explanation of how to build the Quarto book yourself
The documentation includes static previews of all notebooks, providing an accessible overview of the notebook content and learning materials.
Please note that these previews are not interactive. To use the notebooks as intended and access all interactive features, users must install the CoastalCodebook computational environment and run the notebooks locally.
If you have a question about the installation process or notebooks, feel free to open an issue. 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 not troubleshoot the notebooks by email!
Would you like to propose changes or additions? We welcome pull requests!
Many people have contributed to this project over the years; see our acknowledgements in the Quarto book. Thank you all!