ac3-book - Gateway to the (AC)³ research project on Arctic amplification

Latest build

This repository holds a jupyter book (version 2) with

• background information
• data descriptions
• example use cases

about and from the Transregional Collaborative Research Centre (TRR 172) on Arctic Amplification: Climate Relevant Atmospheric and Surface Processes, and Feedback Mechanisms (AC)³ (2015 - 2027).

This book is being build as a place of exchange for researches inside and outside the (AC)³ project. It should help you learn more about our research results and quickly find the data, on which we based our results.

Roadmap

• Develop structure of the book
• Incorporate ac3-notebooks and ac3airborne
• Develop a template to provide members to add example notebooks showcasing the use of some data
• Link each example notebook to the platform(s) and data source(s) it uses
• List all example notebooks on the page of the respective platform(s) that created the data for it
• Port information from the website to the book
• Port partial information from campaign wikis and websites to the book
  • ACLOUD
  • HALO-AC3
  • COMPEX
  • PASCAL -> where is the wiki
• Add instrument cards
  • HALO
  • P5
  • P6
  • Polarstern
  • Beluga
• Add platform cards
  • HALO
  • P5
  • P6
  • Polarstern
  • Spaceborne
  • Ground based
• Add short model descriptions
  • ICON
  • ICON-LEM
  • ERA5
  • Merra
  • Carra
• Add software
  • PAMTRA
  • pyRadTran
  • ac3-airborne

Contribute

Help to grow this project by raising an issue or suggesting an edit directly at one of the book pages (to be implemented by the mystmd book theme). You can also open a pull request if you want to add more example notebooks.

Local Setup

"Jupyter Book 2 is a very thin wrapper around the MyST-MD engine: it shares the same CLI and configuration file. It serves primarily as an introduction of the existing Jupyter Book community to the MyST-MD engine. If you're new to the Jupyter Book project, consider directly using MyST-MD." (from next.jupyterbook.org)

We follow this advice in the description below.

Here's how to set up the ac3-book book for local development.

1. Fork the repo on GitHub.
2. Clone your fork locally.
3. Run pixi install in the local directory to use pixi to set up the python environment
4. Create a branch for local development and make changes locally. See the mystmd guide for help on syntax.
5. Build the book locally to see if the fully-rendered HTML version looks as intended.

   cd book  # change into the book directory
   pixi run myst start  # start your local webserver

6. Commit your changes and push your branch to your fork on GitHub.
7. Create a pull request through the GitHub website.

References and Inspiration

• How to EUREC4A
• How to ac3airborne
• Orcestra
• jupyter book v2
• MystMD

License

Content in the ac3-book © 2025 by the Transregional Collaborative Research Centre 172 (AC)³ is licensed under CC BY 4.0

Code within this repository is licensed under MIT.