Documentation facelift #275
Draft
Conversation
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
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #275 +/- ##
==========================================
+ Coverage 87.11% 89.01% +1.89%
==========================================
Files 15 17 +2
Lines 1281 1803 +522
==========================================
+ Hits 1116 1605 +489
- Misses 165 198 +33 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
not sure if it fits in this PR or a future one, but we have a lot of example docs implemented within docstrings in various parts of the code (i am one of the guilty parties). as part of a fuller refactor, we should decide whether to leave that as-is, migrate it to specific |
… a sum of nearest-line distances between a theoretical line list and a transformed observed line list.
…with respect to x.
Renamed `wavecal.py` to `lswavecal1d.py` and refactored the `WavelengthSolution1D` class for improved clarity and functionality. Added new methods like `refine_fit`, `pix_to_wav`, and `wav_to_pix`, and modified existing ones to enhance flexibility and maintainability.
Introduce `WavelengthSolution2D` class for 2D wavelength calibration, extending functionality from 1D calibration.
…el and spectral frames.
… type hints, documentation, and method structure. Added new methods for calculating inverse transformations and derivatives. Enhanced plotting functionality with additional parameters and refined docstrings for clarity.
…where `arc_spectra` is `None`.
… `plim` parameter for pixel range control in plotting.
…, and modularity, while resolving associated issues. Enhanced methods for handling pixel-to-wavelength mappings, line-matching processes, and plotting capabilities. Added new functions and properties for better control over data and fit refinement.
…ns with setters to ensure proper masking and validation. Added `plot_lines_pix` and `plot_lines_wav` methods for enhanced modularity in plotting observed and theoretical lines.
…thods, updated property names, and enhanced plotting functionality.
…umentation for plotting and fitting methods.
…e maximum number of iterations for refining the pixel-to-wavelength transformation. This ensures the process adjusts until convergence or the specified iteration limit is reached.
…lines for wavelength calibration
- Added `sphinx-copybutton` and `sphinx-design` to documentation dependencies in `pyproject.toml`. - Improved content structure by renaming and reorganizing documentation files. - Expanded "Contributing" and "Index" sections.
…action examples; updated `conf.py` with formatting adjustments and extended Sphinx documentation settings.
- Corrected typos and clarified text. - Renamed `common.py` to `quickstart.py`. - Updated function and variable names for consistency. - Streamlined background subtraction and wavelength calibration workflows.
…uncertainty handling.
…tdDevUncertainty` when absent.
hpparvi
force-pushed
the
documentation_facelift
branch
from
7ee2d16 to
c7344e7
Compare
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.
This draft PR modernizes the documentation by switching to use
sphinx_astropy.conf.v2withpydata-sphinx-theme. The PR mainly rearranges existing documentation without adding much new text at the moment (I've written a bit about tracing, but this is a work in progress).The PR is not ready for merging yet because some information is still duplicated, and some important topics (such as contributing) require further work.