Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,10 @@ instance/
# Sphinx documentation
docs/_build/

# Reference data downloaded by example and validation notebooks
# Reference data downloaded by example and validation notebooks, and catalog validation scripts
docs/validation/data/
docs/examples/osse/data/
validation/data/

# PyBuilder
.pybuilder/
Expand Down
8 changes: 5 additions & 3 deletions CHANGELOG.md

Large diffs are not rendered by default.

38 changes: 29 additions & 9 deletions docs/api_reference/catalog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,27 +14,26 @@ Entries

.. autofunction:: tatc.catalog.list_entries

.. autofunction:: tatc.catalog.build_payload

.. autopydantic_model:: tatc.catalog.InstrumentEntry

.. autoclass:: tatc.catalog.InstrumentPayload

Attitudes by Day
----------------

.. autopydantic_model:: tatc.catalog.TiltSchedule

.. autofunction:: tatc.catalog.get_subsolar_latitude
:members:

Validation Status
-----------------

See :doc:`/validation/standard`.

.. autoclass:: tatc.catalog.EntryValidation
:members:

.. autoclass:: tatc.catalog.ConfigurationValidation
:members:

.. autoclass:: tatc.catalog.GateResult
:members:

.. autoclass:: tatc.catalog.Tier
:members:
Expand All @@ -45,9 +44,30 @@ See :doc:`/validation/standard`.
.. autoclass:: tatc.catalog.InstrumentClass
:members:

.. autofunction:: tatc.catalog.get_gates
Schemas
-------

The schemas of the files of entries and of their validation records.

.. autopydantic_model:: tatc.catalog.schemas.Configuration

.. autopydantic_model:: tatc.catalog.schemas.InstrumentSpecification

.. autopydantic_model:: tatc.catalog.schemas.Provenance

.. autopydantic_model:: tatc.catalog.schemas.TiltSchedule

.. autopydantic_model:: tatc.catalog.schemas.ConfigurationRecord

.. autopydantic_model:: tatc.catalog.schemas.Transfer

.. autofunction:: tatc.catalog.schemas.get_period_days

Standard
--------

.. autofunction:: tatc.catalog.get_required_grades
.. automodule:: tatc.catalog.standard
:members: STANDARD_VERSION, COMPATIBLE_VERSIONS, MIN_HOLDOUT_GAP_DAYS, Gate, get_gates, get_required_grades, is_compatible

Metrics
-------
Expand Down
4 changes: 4 additions & 0 deletions docs/api_reference/utils/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Utility Functions

.. autofunction:: tatc.utils.compute_glint_angle

.. autofunction:: tatc.utils.compute_subsolar_latitude

.. autoclass:: tatc.utils.VelocityFrame
:members:

Expand Down Expand Up @@ -75,6 +77,8 @@ Utility Functions

.. autofunction:: tatc.utils.compute_argument_of_latitude

.. autofunction:: tatc.utils.compute_ascending_argument_of_latitude

.. autofunction:: tatc.utils.compute_j2_raan_rate

.. autofunction:: tatc.utils.compute_j2_aop_rate
Expand Down
26 changes: 26 additions & 0 deletions docs/examples/coverage/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
=================
Coverage Analyses
=================

These notebooks choose where to sample and analyze what observations
sample:

#. :doc:`GenerateRandomPoints`: generate random points, uniformly or weighted
by a population grid, and find when an imaging satellite observes them.
#. :doc:`FindCoincidentObservations`: find when two or more satellites
observe the same place at nearly the same time, as points and as ground
tracks.
#. :doc:`AssessSamplingSufficiency`: assess whether a constellation samples a
varying field sufficiently, from the error of its estimates, its revisits,
and the times of day it sees, and test the estimates with a synthetic
nature run.

The AssessSamplingSufficiency example also requires xarray
(``pip install xarray``) for its nature run.

.. toctree::
:hidden:

GenerateRandomPoints.ipynb
FindCoincidentObservations.ipynb
AssessSamplingSufficiency.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -669,7 +669,7 @@
"source": [
"## Compare a Detailed VIIRS Model\n",
"\n",
"The VIIRS instrument above is a simple model: a nadir `Instrument` whose field of regard spans a nominal 3,000 km swath, so that its footprint at each time is a circle around the sub-satellite point. The [VIIRS validation](../validation/ValidateImagerVIIRS.ipynb) fits a more detailed model to NOAA-20's geolocated pixels:\n",
"The VIIRS instrument above is a simple model: a nadir `Instrument` whose field of regard spans a nominal 3,000 km swath, so that its footprint at each time is a circle around the sub-satellite point. The [VIIRS validation](../../validation/instruments/ValidateImagerVIIRS.ipynb) fits a more detailed model to NOAA-20's geolocated pixels:\n",
"\n",
"* **Scan extent.** VIIRS samples scan angles from -56.13 to +55.96 deg (positive to the left): a `PointedInstrument` whose cross-track field of view spans them, rolled 0.085 deg to the right.\n",
"* **Scan geometry.** Each scan images 16 detector rows, which subtend a constant angle along track at every scan angle, so that scans grow longer toward the swath edges (the \"bow tie\" effect). `ViewGeometry.SCAN` represents this.\n",
Expand Down Expand Up @@ -1075,7 +1075,7 @@
"id": "fa6b9dd9",
"metadata": {},
"source": [
"Between the equator and 20 deg north, the detailed swath is about 45 km wider than the simple one at one scan period, because VIIRS's measured scan extent is wider than the field of regard of a nominal 3,000 km swath, and contains it entirely. At 2-minute steps, the simple model also misses the scalloped strips along each edge between its circular footprints. Each model suits a purpose: the simple field of regard is fast and adequate for coverage over long periods at coarse time steps, while the detailed model reproduces VIIRS's scans, their bow tie overlap, and their orientation, for analyses at the scale of individual scans (see the [VIIRS validation](../validation/ValidateImagerVIIRS.ipynb) for observation times and swath widths compared with the instrument's data)."
"Between the equator and 20 deg north, the detailed swath is about 45 km wider than the simple one at one scan period, because VIIRS's measured scan extent is wider than the field of regard of a nominal 3,000 km swath, and contains it entirely. At 2-minute steps, the simple model also misses the scalloped strips along each edge between its circular footprints. Each model suits a purpose: the simple field of regard is fast and adequate for coverage over long periods at coarse time steps, while the detailed model reproduces VIIRS's scans, their bow tie overlap, and their orientation, for analyses at the scale of individual scans (see the [instrument catalog](../../validation/catalog.rst) for observation times and swath widths of the catalog's VIIRS entry compared with the instrument's data)."
]
}
],
Expand Down
Loading
Loading