Add note to readme about test metrics

make readme markdown
lsst · Nov 16, 2017 · 2cf6463 · 2cf6463
1 parent 0b2dfc4
commit 2cf6463
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/README b/README
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,12 @@
+# Joint Calibration
+
+This package performs joint astrometry and photometry across multiple visits of the same field, fitting models for the astrometric distortions and photometric calibrations of the CCDs and focal plane.
+
+It was derived from lsst_france/meas_simastrom
+
+## A note on tests
+
+All of the `tests/test_jointcal_<obs>.py` tests run jointcal on their respective `testdata_jointcal/<obs>` dataset.
+The numeric values being tested (the metrics, pa1, and relative/absolute rms) were not computed in advance, but are empirical, from the first time that test was successfully run.
+They are updated when changes to the algorithm warrants, e.g. a change to outlier rejection might affect the final chi2/ndof for some of the testdata.
+More sophisticated testing of jointcal's validity is handled by `validate_drp` on much larger datasets that have multiple full-focal plane visits.