Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
46debe1
add tradespace module for trade studies of design spaces
ptgrogan Nov 10, 2026
7396469
add replicate statistics, requirements, adaptive replication, and con…
ptgrogan Nov 10, 2026
a9979f2
add sampling sufficiency analysis, result stores, failures, and sensi…
ptgrogan Nov 10, 2026
8070e73
fix documentation build warnings
ptgrogan Nov 10, 2026
f574ef3
add IMERG validation of sampling error estimates and per-target decor…
ptgrogan Nov 10, 2026
fec2b10
Merge branch 'instrument-catalog' into tradespace
ptgrogan Nov 11, 2026
86c376a
key stored results by study fingerprints, add confirmation with new r…
ptgrogan Nov 11, 2026
802db3b
support dynamic categorical options and design budgets in Optuna sear…
ptgrogan Nov 11, 2026
dea6787
add phase and node fractions of the lead satellite of Walker layouts
ptgrogan Nov 11, 2026
5dca91c
add trains, planes of inclined orbits, mixed layouts, and phase fract…
ptgrogan Nov 11, 2026
c1de3c1
add life-cycle cost models of constellations, and fingerprints of dat…
ptgrogan Nov 11, 2026
390733b
speed up Pareto fronts with tolerances, sweeps, and quantiles of repl…
ptgrogan Nov 11, 2026
5ca9e33
add cost schedules with present values and annual costs
ptgrogan Nov 11, 2026
8cf6a4e
schedule costs from production rates, launch cadence, and development…
ptgrogan Nov 11, 2026
b35ceb4
separate deployment from costs, and evaluate capability over the phas…
ptgrogan Nov 11, 2026
10ae93b
simulate missions with failures of satellites and launches, and polic…
ptgrogan Nov 11, 2026
76f58ac
expose restoration policies as design variables with policy_space and…
ptgrogan Nov 11, 2026
06b0610
evaluate many histories of missions per replicate with a cache of pha…
ptgrogan Nov 11, 2026
a6f038a
vectorize sampling error estimates over targets
ptgrogan Nov 11, 2026
f86738a
vectorize revisit statistics over targets
ptgrogan Nov 11, 2026
aaa876e
stratify failure histories and estimate mission means with control va…
ptgrogan Nov 11, 2026
0abff12
include a hash of the source of TAT-C in fingerprints of studies
ptgrogan Nov 11, 2026
c2b017d
add rotated-lattice points and allocation of replicates and histories
ptgrogan Nov 11, 2026
9322cf4
add exact expectations of missions without restoration and importance…
ptgrogan Nov 11, 2026
4d66e11
use rotated-lattice points and exact expectations of degraded mission…
ptgrogan Nov 11, 2026
f83aff6
judge designs by criteria, and key stores of results by the definitio…
ptgrogan Nov 12, 2026
2ef1b98
attribute the variance of replicates, and judge designs across scenar…
ptgrogan Nov 12, 2026
79abd87
describe layouts of constellations, and stage deployments by rules
ptgrogan Nov 12, 2026
885e063
add studies of the observations of constellations, and plots of trade…
ptgrogan Nov 12, 2026
0563844
document the trade space refactor in the changelog, API reference, an…
ptgrogan Nov 12, 2026
108ab9e
Merge branch 'instrument-catalog' into tradespace
ptgrogan Nov 12, 2026
7b8c0c8
Merge branch 'instrument-catalog' into tradespace
ptgrogan Nov 12, 2026
f051666
size mission plans by the values of each design
ptgrogan Nov 12, 2026
d17e214
judge designs across the scenarios of a study, also in searches
ptgrogan Nov 12, 2026
8c5771f
let the rules of stages read the capability of the satellites at a de…
ptgrogan Nov 12, 2026
83df9f1
make the trade space easier to understand and use
ptgrogan Nov 12, 2026
e680409
structure the cost risk of designs by the components they share
ptgrogan Nov 13, 2026
7f4ac5a
produce satellites in blocks that redevelop their type and restart le…
ptgrogan Nov 13, 2026
ce84e76
Merge remote-tracking branch 'origin/main' into tradespace
ptgrogan Nov 13, 2026
35de0bf
test the tradespace extra in CI, and skip parallel studies without jo…
ptgrogan Nov 13, 2026
a380a33
copy the metrics of a design before marking its infeasible replicates
ptgrogan Nov 13, 2026
d7b36c7
Merge remote-tracking branch 'origin/main' into tradespace
ptgrogan Nov 13, 2026
578f1d8
reproduce the two-constellation cost variance example of Maier et al.…
ptgrogan Nov 13, 2026
8079ab1
add a design life of each type of satellite, and sustained deployment…
ptgrogan Nov 13, 2026
4cefdc8
add an example notebook that shows the qualities of the sampling suff…
ptgrogan Nov 13, 2026
1742dd6
restructure the trade space examples as a tutorial of eight notebooks…
ptgrogan Nov 14, 2026
11882ff
move the OSSE examples to docs/examples/osse, which keeps their downl…
ptgrogan Nov 14, 2026
1c40918
add figures to the trade space tutorial notebooks that had few, and c…
ptgrogan Nov 14, 2026
dbe007b
name the number of planes and satellites in each plane alike in the c…
ptgrogan Nov 14, 2026
8078f02
review the trade space again: prune only a study's own stale evaluati…
ptgrogan Nov 14, 2026
d89e913
review the trade space a third time: prune only evaluations and obser…
ptgrogan Nov 14, 2026
8efd1a1
review the trade space a fourth time: fingerprint the globals of a st…
ptgrogan Nov 14, 2026
28b6e2a
give generate_points_fibonacci_lattice a count of points and a random…
ptgrogan Nov 14, 2026
76a3cee
review the trade space a fifth time: fingerprint objects by their __f…
ptgrogan Nov 15, 2026
bfc470b
review the trade space a sixth time, to simplify it: summarize replac…
ptgrogan Nov 15, 2026
822cb6e
review the trade space a seventh time: fingerprint statistics by thei…
ptgrogan Nov 15, 2026
3da6e9f
skip the tests of highlights and shares without matplotlib
ptgrogan Nov 15, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/unit-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:

- name: Install project in editable mode
run: |
pip install -e ".[preprocess]"
pip install -e ".[preprocess,tradespace]"

- name: Run unit tests
run: python -m unittest
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ docs/_build/

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

# PyBuilder
.pybuilder/
Expand Down
37 changes: 37 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Python Versions](https://img.shields.io/pypi/pyversions/tatc.svg)](https://pypi.org/project/tatc/)
[![Unit Tests](https://github.com/code-lab-org/tatc/actions/workflows/unit-test.yml/badge.svg)](https://github.com/code-lab-org/tatc/actions/workflows/unit-test.yml)
[![Documentation](https://readthedocs.org/projects/tatc/badge/?version=latest)](https://tatc.readthedocs.io)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](LICENSE)
[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg)](https://github.com/code-lab-org/tatc/blob/main/LICENSE)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17363628.svg)](https://doi.org/10.5281/zenodo.17363628)

The Tradespace Analysis Toolkit for Constellations (TAT-C) provides low-level
Expand Down Expand Up @@ -35,6 +35,7 @@ Note: the following optional dependencies are available with bracket notation:
* `pip install -e ".[examples]"`: for running optional examples
* `pip install -e ".[osse]"`: for running optional observing system simulation experiment (OSSE) examples
* `pip install -e ".[preprocess]"`: for preprocessing functions (e.g., terrain masks)
* `pip install -e ".[tradespace]"`: for parallel trade studies and searches with optimizers (joblib, Optuna, and pymoo)
* `pip install -e ".[validation]"`: for running validation notebooks (includes `examples` and `preprocess`)

Multiple optional dependencies can be installed with a comma-separated list (e.g., `pip install -e ".[dev,examples]"`)
Expand Down Expand Up @@ -100,12 +101,12 @@ pylint --rcfile=.pylintrc src/tatc
## License

This project is licensed under the BSD 3-Clause License — see
[LICENSE](LICENSE) for details.
[LICENSE](https://github.com/code-lab-org/tatc/blob/main/LICENSE) for details.

## Citation

If you use TAT-C in your research, please cite it using the metadata in
[CITATION.cff](CITATION.cff), or the DOI badge above for the latest release.
[CITATION.cff](https://github.com/code-lab-org/tatc/blob/main/CITATION.cff), or the DOI badge above for the latest release.

## Contact

Expand Down
1 change: 1 addition & 0 deletions docs/api_reference/analysis/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Analysis functions simulate mission operation to compute key performance metrics
:maxdepth: 1

coverage
sufficiency
track
coincidence
feature_coverage
Expand Down
23 changes: 23 additions & 0 deletions docs/api_reference/analysis/sufficiency.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Statistical Sufficiency
=======================

.. automodule:: tatc.analysis.sufficiency
:no-members:

Estimate Sampling Errors
------------------------
.. autofunction:: tatc.analysis.estimate_sampling_error

.. autofunction:: tatc.analysis.sampling_error_variance

Sample Fields
-------------
.. autofunction:: tatc.analysis.sample_field

.. autofunction:: tatc.analysis.compare_sampled_means

Revisits and Local Times
------------------------
.. autofunction:: tatc.analysis.compute_revisit_statistics

.. autofunction:: tatc.analysis.compute_local_time_coverage
4 changes: 4 additions & 0 deletions docs/api_reference/generation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ Weights for random points can be read from a GeoTIFF raster with
:func:`tatc.preprocess.read_raster_weights` (requires the optional
`preprocess` dependencies, ``pip install tatc[preprocess]``).

Rotated Lattice
---------------


Cells
=====

Expand Down
1 change: 1 addition & 0 deletions docs/api_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@ The following provide documentation on the Python API to TAT-C.
catalog
generation/index
analysis/index
tradespace/index
preprocess/index
utils/index
102 changes: 102 additions & 0 deletions docs/api_reference/tradespace/define.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
==============
Design Spaces
==============

.. automodule:: tatc.tradespace.space
:no-members:

Design Spaces and Designs
=========================

.. autoclass:: tatc.tradespace.DesignSpace
:members: enumerate, size, sample, design, designs_of, extend, uncertain_paths

.. autoclass:: tatc.tradespace.Design
:members: flat, uncertain_values, realize, values, decisions, scenario

.. autodata:: tatc.tradespace.space.RESERVED_NAMES
:annotation:

.. autodata:: tatc.tradespace.space.STATUS_COLUMNS
:annotation:

Variables and Values
====================

.. autoclass:: tatc.tradespace.Real

.. autoclass:: tatc.tradespace.Integer

.. autoclass:: tatc.tradespace.Categorical

.. autoclass:: tatc.tradespace.Fixed

.. autoclass:: tatc.tradespace.Derived

.. autoclass:: tatc.tradespace.Uncertain
:members: uniform, normal, triangular, choice, seed

.. autoclass:: tatc.tradespace.Choice

.. autoclass:: tatc.tradespace.Repeat

.. autoexception:: tatc.tradespace.Infeasible

.. autoclass:: tatc.tradespace.nodes.Variable
:members: domain

Building Blocks of Constellations
=================================

Fragments of design spaces of common layouts of constellations, and of the
policies that restore their failures, whose values a study builds into
satellites (see :doc:`missions` for the layouts themselves).

.. autofunction:: tatc.tradespace.walker_space

.. autofunction:: tatc.tradespace.sso_planes_space

.. autofunction:: tatc.tradespace.planes_space

.. autofunction:: tatc.tradespace.soc_space

.. autofunction:: tatc.tradespace.mog_space

.. autofunction:: tatc.tradespace.policy_space

.. autofunction:: tatc.tradespace.build_constellation

.. autofunction:: tatc.tradespace.count_satellites

.. autofunction:: tatc.tradespace.count_planes

Views of Values
===============

The callables of a design space (bounds, derived values, and constraints)
and the values of designs are views of the values decided so far.

.. autoclass:: tatc.tradespace.values.Values

.. autoclass:: tatc.tradespace.values.ChoiceValues
:members: choice, value

.. autoclass:: tatc.tradespace.values.RepeatValues
:members: count

.. autoclass:: tatc.tradespace.values.Scope

.. autofunction:: tatc.tradespace.values.generic_path

Reading Designs
===============

.. automodule:: tatc.tradespace.references
:no-members:

.. autodata:: tatc.tradespace.references.Reference
:annotation:

.. autofunction:: tatc.tradespace.value_of

.. autofunction:: tatc.tradespace.configure
72 changes: 72 additions & 0 deletions docs/api_reference/tradespace/evaluate.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
=======
Studies
=======

Trade Studies
=============

.. autoclass:: tatc.tradespace.Study
:members: run, realize, replace, prune, workers, definition, fingerprint

Observation Studies
===================

.. automodule:: tatc.tradespace.observations
:no-members:

.. autoclass:: tatc.tradespace.ObservationStudy
:members: satellites_of, targets_of, observations_of, mission_of, prune

.. autoclass:: tatc.tradespace.Observations
:members: start_of, end_of, prune, __call__

.. autoclass:: tatc.tradespace.Targets

The parts of observation studies read the values of designs by references
(see :doc:`define` for :py:data:`tatc.tradespace.references.Reference` and
:py:func:`tatc.tradespace.value_of`).

Missions of Designs
===================

.. automodule:: tatc.tradespace.plans
:no-members:

.. autoclass:: tatc.tradespace.MissionPlan
:members: plan_mission

.. autoclass:: tatc.tradespace.Failures

.. autoclass:: tatc.tradespace.mission.Mission
:members: phases, estimate, histories, capability, requirements

Stores of Results
=================

.. autoclass:: tatc.tradespace.ResultStore
:members: clear

Caches of Satellites
====================

.. automodule:: tatc.tradespace.cache
:no-members:

.. autoclass:: tatc.tradespace.SatelliteCache
:members: __call__, prune, clear_memory, folder, fingerprint, hits, misses

.. autofunction:: tatc.tradespace.cache.get_satellite_key

Fingerprints
============

.. automodule:: tatc.tradespace.fingerprint
:no-members:

.. autofunction:: tatc.tradespace.fingerprint.get_fingerprint

.. autofunction:: tatc.tradespace.fingerprint.get_definition

.. autofunction:: tatc.tradespace.fingerprint.compare_definitions

.. autofunction:: tatc.tradespace.fingerprint.describe
Loading
Loading