CoastalCodeBook
  1. Usage
  2. Building the book
  • 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. Building the book

Building the book

Running Quarto locally

  • @ this needs to be revised to explain the local book building with quarto
  • @ also check in installation instructions the kernel registration in the environment versus the below system-wide kernel registration

If you’d like to build the book yourself you should:

  1. Fork this repository
  2. Run mamba env create -f ci/envs/coastal.yml
  3. Run mamba activate coastal
  4. Run jupyter-book build book

A fully-rendered HTML version of the book will be built in book/_build/html/.

Known issue: If you use nb_conda_kernels to expose your environments, you might run into kernelspec errors when building the book. Until this issue is fixed, a workaround is to add the environments manually to the kernselspec:

  1. Run mamba activate coastal
  2. Run python -m ipykernel install --user --name conda-env-coastal-py --display-name "conda-env-coastal-py"
Troubleshooting
1a: Tectonic classification