alice-crafford / Photo-z-Stress-Test

Summer project, using RAIL
1 stars 0 forks source link

Review the documentation #2

Open aimalz opened 1 year ago

aimalz commented 1 year ago

RAIL has documentation explaining the basic structures that Olivia and I are currently overhauling in a fork. Please leave comments on this issue to bring to our attention unanswered questions you wish were addressed in the documentation and specific things that need to be revised, i.e. the parts that don't make sense, and we'll try to fix them as they come up.

alice-crafford commented 1 year ago

These might be a bit specific to me, but some questions I have so far:

alice-crafford commented 1 year ago

Also:

alice-crafford commented 1 year ago

Here are some comments/questions about degrader documentation:

Grid Selection:

LSST Error Model:

Observing Conditions:

Quantity Cuts:

alice-crafford commented 1 year ago

qp demo: storing/retrieving ensembles section: syntax in description doesn't match actual syntax: qp.Ensemble.read_from should be qp.Ensemble.read

alice-crafford commented 1 year ago

There should be info about how to access raw PIT values & plot a histogram in the RAIL evaluation demo

Update: I think I figured this one out; it was just as simple as things being in a 2D array vs. a 1D array