Skip to content

Add tutorial with Literate + Binder setup#806

Merged
ocots merged 16 commits into
mainfrom
paderborn
Jul 9, 2026
Merged

Add tutorial with Literate + Binder setup#806
ocots merged 16 commits into
mainfrom
paderborn

Conversation

@ocots

@ocots ocots commented Jul 8, 2026

Copy link
Copy Markdown
Member

Summary

  • Add a guided tour tutorial (docs/src-literate/tutorial.jl) covering: @def macro and macro-free API, direct method (double integrator + Goddard), initial guess, grid continuation, solver switching (Ipopt/MadNLP), GPU token error, indirect method (Pontryagin shooting)
  • Integrate Literate.jl in docs/make.jl to generate tutorial.md, tutorial.ipynb, and tutorial.jl from a single source
  • Configure Binder (binder/Project.toml, postBuild, apt.txt) for executable notebook
  • Enable global draft mode with @meta Draft = false override for the tutorial only
  • Binder badge points to paderborn branch (to be updated to main after merge)

Files

  • docs/src-literate/tutorial.jl — Literate source
  • docs/src-literate/tutorial_pre.jl — LOAD_PATH setup
  • docs/make.jl — Literate generation block + draft mode + tutorial in pages
  • binder/ — Binder configuration
  • docs/src/notebooks/tutorial.ipynb — Generated notebook (committed for Binder)
  • docs/src/tutorial.md — Generated markdown
  • docs/src/scripts/tutorial.jl — Generated script

- tutorial.jl: guided tour (double integrator + Goddard, direct & indirect)
- Literate generation in make.jl (markdown + notebook + script)
- Binder config (Project.toml, postBuild, apt.txt)
- Draft mode enabled globally, tutorial overrides with @meta Draft=false
- Binder badge points to paderborn branch
@ocots ocots added the run documentation Trigger Documentation label Jul 8, 2026
@ocots ocots removed the run documentation Trigger Documentation label Jul 9, 2026
@ocots
ocots marked this pull request as ready for review July 9, 2026 11:45
@ocots
ocots merged commit 5bca31f into main Jul 9, 2026
6 checks passed
@ocots
ocots deleted the paderborn branch July 9, 2026 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant