Skip to content

Commit 61cfe89

Browse files
Add environment setup, complete macro list, and build details to CLAUDE.md
Adds Python version requirement, pip install instructions, deployed site URL, all custom math macros, sphinx-proof directives, figure conventions, and the missing make pdf target. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 008d449 commit 61cfe89

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

CLAUDE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,30 @@ University course materials repository for "Introduction to Planetary Science" a
2323

2424
Uses **Jupyter Book v1** (`jupyter-book<2`) with Sphinx backend. Dependencies in `requirements.txt`.
2525

26+
### Environment setup
27+
28+
Requires Python 3.12+.
29+
30+
```bash
31+
pip install -r requirements.txt
32+
```
33+
34+
### Build commands
35+
2636
```bash
2737
make html # Build browsable HTML → book/_build/html/
38+
make pdf # Build PDF via pdfhtml → book/_build/pdf/
2839
make pdflatex # Build PDF via XeLaTeX → book/_build/latex/
2940
make clean # Remove build artifacts
3041
```
3142

3243
Build artifacts in `book/_build/` are gitignored.
3344

45+
### Deployed site
46+
47+
HTML is auto-deployed to GitHub Pages on push to `main`:
48+
https://formingworlds.github.io/IntroductionToPlanetaryScience/
49+
3450
## Key Technical Details
3551

3652
- The course covers 14 lectures spanning planet formation through exoplanets and astrobiology (see `planning/course_development.md` for full curriculum, schedule, homework, and exam structure).
@@ -39,6 +55,14 @@ Build artifacts in `book/_build/` are gitignored.
3955
- Math macros are defined in both `mathjax3_config` (HTML) and `latex_elements.preamble` (PDF) in `_config.yml` — new macros must be added to both.
4056
- The `physics` LaTeX package conflicts with Sphinx output; custom `\dv`, `\dd`, `\pdv` macros are used instead.
4157
- LaTeX packages available: `amsmath`, `amssymb`, `mhchem` (for chemical formulae like `\ce{CO2}`).
58+
- Custom math macros defined in `_config.yml` (available in both HTML and PDF):
59+
- `\dv{f}{x}` — total derivative, `\dd` — differential d, `\pdv{f}{x}` — partial derivative
60+
- `\Msun`, `\Rsun`, `\Lsun` — solar mass, radius, luminosity
61+
- `\Mearth`, `\Rearth` — Earth mass, radius
62+
- `\Mjup`, `\Rjup` — Jupiter mass, radius
63+
- `\kB` — Boltzmann constant
64+
- The `sphinx-proof` extension is loaded, providing theorem-like directives: `{prf:theorem}`, `{prf:proof}`, `{prf:definition}`, `{prf:example}`, etc.
65+
- Figures live in `<lecture_dir>/figures/` and are referenced with MyST syntax: `` ```{figure} figures/filename.png``` ``
4266

4367
## References & Citations
4468

0 commit comments

Comments
 (0)