Documentation, API reference, and pipeline improvements — merge dev into main#70
Merged
charliekilpatrick merged 4 commits intomainfrom Mar 2, 2026
Merged
Documentation, API reference, and pipeline improvements — merge dev into main#70charliekilpatrick merged 4 commits intomainfrom
charliekilpatrick merged 4 commits intomainfrom
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
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.
Description
This PR merges the
devbranch intomain, bringing in API documentation, contributing guidelines, pipeline and test updates, and conda environment naming consistency.Summary of changes
Documentation
docs/source/api/: generated.rstfor instruments (BINOSPEC, DEIMOS, F2, FOURSTAR, GMOS, IMACS, LRIS, MMIRS, MOSFIRE, base instrument), primitives (absphot, calibration, image_procs, photometry, solve_wcs, sort_files), scripts (download_anet_index, download_gemini_data, download_keck_data, main_pipeline), and utils (logger, options, utilities).docs/source/conf.py,index.rst, andinstallation.rst.Contributing and project setup
CONTRIBUTING.mdwith guidelines for reporting issues, contributing code/docs, and support.potpyri(replacingpotpyri_test) inenvironment.ymland related docs.pyproject.tomlupdated (metadata and/or dependencies).Pipeline and library
instrument.pyextended; small tweaks across BINOSPEC, DEIMOS, F2, FOURSTAR, GMOS, IMACS, LRIS, MMIRS, MOSFIRE).absphot,calibration,image_procs,photometry,solve_wcs, andsort_files.potpyri/scripts/__init__.pyadded;main_pipelineand related script behavior/logic updated.logger,options, andutilitiesimproved.Tests
tests/test_image_procs.py.test_absphot,test_calibration,test_photometry,test_sort,test_wcs, and others.Commits on dev (not on main)
potpyripotpyri_testtopotpyriScope
main_pipeline INSTRUMENT DATA_PATHand documented options remain the same.Checklist
cd docs && make htmlpytest tests