Repository navigation
docs: migrate to Zensical and overhaul the documentation - #157
Open
tlambert03 wants to merge 30 commits into
Open
tlambert03 wants to merge 30 commits into
tlambert03 wants to merge 30 commits into
Conversation
- replace mkdocs with Zensical (zensical.toml), mkdocstrings API reference with griffe-fieldz, mermaid, glightbox, abbreviations - new structure: getting started, user guide, tutorials, API, about - figures generated at build time by scripts/make_doc_figures.py (tutorial figures come from executing the tutorial page's code) - version-pinning warnings on home, installation, settings, saving, README - docstring fixes and additions across the schema - move tutorial notebook to examples/notebooks - CI builds with --strict and deploys via ghp-import Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ed against microsim - docs/javascripts/physics/photometry.js mirrors the photon budget calculations, with pointers to the Python; tests/test_js_physics.py runs it in node - charts mount on Zensical's document$ (instant navigation), load Plot and d3 from jsDelivr (pinned), and use CSS variables for light/dark - spectra and filter data exported at build time to docs/data/generated/ Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… HyD dead time) - docs/javascripts/physics/detectors.js mirrors the detector formulas; the analytic SNR is tested against microsim's detector simulation - SNR chart shows microsim Monte Carlo points at the starting parameters Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… notes Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- scripts/make_notebooks.py converts each tutorial page to a notebook whose first cell installs microsim at the docs' commit; published with the site - all tutorial figures are made by running the tutorial pages' code (the own-ground-truth and point-detector tutorials now include their plotting code); removes the hand-maintained tutorial notebook - remove the unused light/dark matplotlib theming Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- noise: a microsim-simulated HeLa cell image recorded by a camera, with the noise drawn in the browser (simulateCamera, with seeded Poisson, gamma, and normal samplers); tested statistically against microsim's render - pinhole: microsim PSFs across pinhole sizes, optical sectioning, and FWHM, all precomputed in Python Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- wording fixes across getting started, channels, samples, modalities - correct what CosemLabel values mean; FPbase name matching; EGFP size - API parameter tables fit the page; prose tables don't wrap names - bleedthrough: interactive crosstalk matrix, and an EGFP/tdTomato example with bandpass vs longpass emission filters - example output of the spectra plotting methods - fix swapped axis labels in OpticalConfig.plot_emission - confocal PSF equation; pinhole explorer can show the signal lost - photon budget: drop specimen RI slider; saturation chart ranges Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…skill - MatsLines parameter examples and an Allen neuron mask, made at build time - three labels from two OpenOrganelle datasets, checked in (slow to make) - document microsim.allen, and its current limits at optical resolution - .claude/skills/check-docs-prose: auditing hand-written docs against code Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nnels) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- one page per public module, from the source, replacing the hand-written API pages; modules re-exported by their package are excluded so each object is documented once - cross-references to members point at their documented paths - microsim.schema gets a module docstring for its (otherwise empty) page Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…w by topic Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…arnings for pydantic models, use the canonical site URL Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…t clip at 0 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…re to use Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…not a figure) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #157 +/- ##
==========================================
+ Coverage 88.15% 88.33% +0.18%
==========================================
Files 48 48
Lines 3292 3293 +1
==========================================
+ Hits 2902 2909 +7
+ Misses 390 384 -6 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…t power, readout order, caches, run_batch, irradiance range) Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…xported data - halfSaturationIrradiance, maxEmissionRate, hydMaxRate, roundHalfEven, each tested against microsim - photon budget chart uses photonBudget; test its result against Simulation.filtered_emission_rates - noise, EMCCD, and PMT charts start from exported presets; photon budget and crosstalk use the exported ObjectiveLens defaults - drop unused illumination/emission exports Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This branch has not been deployed
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
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.
This moves the docs from mkdocs-material to Zensical and rewrites most of the content.