CoastalCodeBook
  1. Usage
  2. Troubleshooting
  • Introduction
  • About the Codebook
    • Introduction
    • Course structure
    • Notebook overview
    • Acknowledgements
  • Usage
    • Installation Guide
    • Getting Started
    • Troubleshooting
    • Building the book
  • Week 1
    • 1a: Tectonic classification
    • 1b: Process-based coastal classification
  • Week 2
    • 2a: Pre-knowledge waves
    • 2b: Wave dispersion and grouping
    • 2c: Generation of the tide
    • 2d: Tidal constituents
  • Week 3
    • 3a: Tidal Environments
    • 3b: Wave asymmetry and skewness
    • 3c: Radiation stresses and wave forces
  • Week 4
    • 4a: Bound long waves
    • 4b: Shallow-water Tides
  • Week 5
    • 5: Coastal Classification and Beach States
  • Week 6
    • 6: Cross-shore transport
  • Week 7
    • 7: Alongshore transport
  • Week 8
    • 8a: Escoffier curve
    • 8b: Tide-induced residual transport (Van de Kreeke and Robaczewska)
    • 8c: Equilibrium concentration versus lag effects
    • 8d: Interventions and natural changes
  1. Usage
  2. Troubleshooting

Troubleshooting

Github issues

Do you run into an issue with the installation or notebook execution? Don’t worry, it’s likely that other students have come across similar trouble. To encourage a collaborative learning environment, we strongly encourage you to share your questions or issues by opening an issue on our GitHub repository.

Please note that we prioritize the GitHub issue tracker for all troubleshooting and support. Direct email requests related to notebooks will not be addressed!

Why Open an Issue?

  • Collaborative Problem-Solving: Issues opened on GitHub can be seen, discussed, and resolved collaboratively by the community.
  • Avoid Duplication: By documenting your problem and the solution on GitHub, you help prevent repeated queries and enable others to benefit from the resolution.
  • Improve the Resource: Your contributions through issues help us identify and fix bugs, leading to improvements in the course material for everyone.

How to Open an Issue

If you’re unfamiliar with the process of creating an issue on GitHub, here is a helpful guide that walks you through the steps. It’s a simple process that involves:

  1. Navigating to the Issues Tab: Click on the ‘Issues’ tab in the repository.
  2. Creating a New Issue: Use the ‘New Issue’ button to start.
  3. Describing the Problem: Provide a clear and concise description of what the issue is, including steps to reproduce it, expected outcomes, and any screenshots if applicable.

JupyterHub

To be added some of the stuff from the BS Rescue Guide

Getting Started
Building the book