Phase 2 docs: concepts, migration guide, PSFs, FAQs, build fix#928
Draft
astronomyk wants to merge 4 commits into
Draft
Phase 2 docs: concepts, migration guide, PSFs, FAQs, build fix#928astronomyk wants to merge 4 commits into
astronomyk wants to merge 4 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #928 +/- ##
==========================================
+ Coverage 72.45% 75.19% +2.73%
==========================================
Files 70 70
Lines 9018 9018
==========================================
+ Hits 6534 6781 +247
+ Misses 2484 2237 -247 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
simcado_migration.rst: side-by-side API mapping table (source creation, UserCommands, run workflow, observing modes) plus explanation of the three key conceptual changes (modular packages, bang-string parameters, MORFEO requirement). concepts.rst: explains the five core objects (Source, OpticalTrain, Effect, UserCommands, Detector), the FOV pipeline, and YAML instrument packages with a complete worked example. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
faq_troubleshooting.md: common errors (missing default.yaml, black image, slow simulation, FITS extension count) with causes and fixes. faq_filters.md: listing filters, changing filter, plotting transmission, custom filters, MICADO filter table, wavelength range gotcha. faq_sources.md: creating stars, fields, clusters, galaxies, combining sources, source from FITS image, setting positions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
psfs.rst: describes all PSF effect classes (FieldConstantPSF, FieldVaryingPSF, AnisocadoConstPSF, SeeingPSF, GaussianDiffractionPSF), how to disable/replace a PSF at runtime, field-varying PSF download info for MICADO, and the FITS file format specification. index.rst: split the single toctree into three labelled sections (Getting Started, Reference, Examples) and add the four new pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…artefacts scopesim_sphinx_ext.py was opening generated RST files with the platform default encoding (cp1252 on Windows), causing the § character in the FitsHeadersHDU docstring to be written as Latin-1 0xA7 rather than UTF-8. Sphinx then failed to read the regenerated file on every build. Add docs/_build/ and docs/source/_autosummary/ to .gitignore so generated build artefacts are not tracked. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
astronomyk
force-pushed
the
kl/scopesim_docs_improvements
branch
from
5e9949c to
36c0419
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
concepts.rst) covering the 5 core objects, pipeline flow, FOVs, and a complete worked examplesimcado_migration.rst) with side-by-side API mapping tables for users coming from SimCADOpsfs.rst) covering all effect classes (FieldConstantPSF,FieldVaryingPSF,AnisocadoPSF,SeeingPSF,GaussianDiffractionPSF), when to use each, and how to swap PSFs at runtimeindex.rstinto three labelled toctrees: Getting Started, Reference, Examplesscopesim_sphinx_ext.py): the custom Sphinx extension was regeneratingeffects_docstrings/*.rstusing the platform default encoding (cp1252 on Windows), writing the§placeholder as a lone0xA7byte that Sphinx then failed to decode as UTF-8. Fixed by addingencoding="utf-8"to theopen()call.docs/_build/anddocs/source/_autosummary/to.gitignoreTest plan
sphinx-build -b html -D nb_execution_mode=off docs/source docs/_build/html— succeeds (36 pre-existing warnings, no errors)index.htmlrenders with three sidebar sections: Getting Started, Reference, Examplesconcepts.html,simcado_migration.html,psfs.htmlall present and linkedfaqs/directory renders with the three new FAQ pages🤖 Generated with Claude Code