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

If you’d like to build the book yourself locally, you can do so using Quarto. Quarto needs to be installed separately from the other CoastalCodebook software requirements. Here we assume you have already installed these requirements as per our installation instructions, including registering the coastalcodebook environment as a Jupyter kernel.

Install Quarto

Follow the official Quarto installation instructions for your operating system.

For Ubuntu/Debian Linux, download the .deb package from the Quarto download page and install it with:

sudo dpkg -i quarto-<version>-linux-amd64.deb

You can check that Quarto is installed correctly with: quarto --version.

Build the book

  1. Navigate to the Quarto directory: cd ~/path/to/CoastalCodebook/quarto
  2. Activate the environment by running mamba activate coastalcodebook
  3. Build the book: quarto render --execute

A fully rendered HTML version of the book will be built in:

~/path/to/CoastalCodebook/quarto/_site/

You can view the generated files in _site/ using your preferred method. For instance, you can serve the _site directory locally:

python -m http.server 8000 --directory _site

And open http://localhost:8000/ in your browser.

Troubleshooting
1a: Tectonic classification