Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme for demo notebooks and updates to cite_sorcha() #744

Merged
merged 4 commits into from
Dec 13, 2023
Merged

update readme for demo notebooks and updates to cite_sorcha() #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8e6a2b5
update readme for demo notebooks
mschwamb Dec 11, 2023
e82d59c
renaming notebooks for consistency
mschwamb Dec 11, 2023
c35fdbd
renaming notebooks for consistency
mschwamb Dec 11, 2023
bde75d9
tidy up cite_sorcha()
mschwamb Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/notebooks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ Notebooks

Apparent Magnitude Validation <notebooks/demo_ApparentMagnitudeValidation>
Circle Footprint Filter <notebooks/demo_CircleFootprint>
LSST Camera Footprint Filter <notebooks/demo_footprintFilter>
LSST Camera Footprint Filter <notebooks/demo_FootprintFilter>
Coordinate Transformation Example <notebooks/demo_CoordinateTransformations.ipynb>
Detection Efficiency Validation <notebooks/demo_DetectionEfficiencyValidation>
SSP Linking Filter <notebooks/demo_LinkingFilter>
Magnitude and SNR Cuts <notebooks/demo_MagnitudeAndSNRCuts>
Trailing Losses Validation <notebooks/demo_TrailingLossesValidation>
Uncertainties and Randomization <notebooks/demo_UncertaintiesAndRandomization>
Vignetting Demo <notebooks/demo_vignetting>
Vignetting Demo <notebooks/demo_Vignetting>
Lightcurve demo <notebooks/demo_Lightcurve>
20 changes: 14 additions & 6 deletions docs/notebooks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,29 @@
## Notebooks:

demo_ApparentMagnitudeValidation
- **Validates:** PPCalculateApparentMagnitudeInFilter.
- **Validates:** PPCalculateApparentMagnitudeInFilter
- **Files:** none

demo_CalculateSimpleCometaryMagnitude
- **Validates:** PPCalculateSimpleCometaryMagnitude
- **Files:** lsst-total-r.dat

demo_CircleFootprint
- **Validates:** PPCircleFootprint
- **Files:** footprintFilterValidationObservations.csv, oneline_v2.0.db

demo_CoordinateTransformations
- **Validates:** universal_cartesian, universal_keplerian
- **Files:** none

demo_DetectionEfficiencyValidation
- **Validates:** PPFadingFunctionFilter
- **Files:** oneline_v2.0.db

demo_footprintFilter
demo_FootprintFilter
- **Validates:** PPFootprintFilter
- **Files:** detector_corners.csv, footprintFilterValidationObservations.csv, oneline_v2.0.db

demo_Lightcurve
- **Validates:** lightcurve_registration (LC_METHODS, update_lc_subclasses), AbstractLightCurve class
- **Files:** none

demo_LinkingFilter
- **Validates:** PPLinkingFilter
- **Files:** none
Expand All @@ -35,3 +39,7 @@ demo_TrailingLossesValidation
demo_UncertaintiesAndRandomization
- **Validates:** PPAddUncertainty, PPRandomizeMeasurements
- **Files:** none

demo_Vignetting
- **Validates:** vignettingEffects
- **Files:** oneline_v2.0.db, footprintFilterValidationObservations.csv
2 changes: 1 addition & 1 deletion docs/notebooks/demo_ApparentMagnitudeValidation.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1037,7 +1037,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.10"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
Loading
Loading