synopsis
Science Yield improvemeNt via Onboard Prioritization and Summary of Information System (SYNOPSIS)
Science Score: 85.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: iop.org -
✓Committers with academic emails
2 of 4 committers (50.0%) from academic institutions -
✓Institutional organization owner
Organization nasa-ammos has institutional domain (ammos.nasa.gov) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.7%) to scientific vocabulary
Repository
Science Yield improvemeNt via Onboard Prioritization and Summary of Information System (SYNOPSIS)
Basic Info
- Host: GitHub
- Owner: NASA-AMMOS
- License: apache-2.0
- Language: C
- Default Branch: main
- Size: 11 MB
Statistics
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 2
- Releases: 0
Metadata Files
README.md
SYNOPSIS: Science Yield improvemeNt via Onboard Prioritization and Summary of Information System
SYNOPSIS is a system to prioritize the downlink of data products, including both raw data products as well as "autonomous science data products" that are extracted onboard the spacecraft to summarize data.
Team
- Mark Wronkiewicz
- Gary Doran
- Jack Lightholder
- Zaki Hasnain
- Rex Stockham
- Robert Brown (JSTAR team at NASA IV&V)
- Scott Zemerick (JSTAR team at NASA IV&V)
- Lukas Mandrake
Building SYNOPSIS
- Run
cmake -S . -B buildto set up the build directory - Run
cmake --build buildto build the code - Run
cd build && ctestto execute the tests
SYNOPSIS Integration into cFS
See the core Flight Software (cFS) README file for instructions on building SYNOPSIS in support of a cFS app.
YouTube: Integration demo with NOS3
Click the below image to see a demo simulating the use of SYNOPSIS (integrated into cFS) for data prioritization. Commands are sent to exercise SYNOPSIS's functionality and a simple dashboard tracks and visualizes data from the OWLS-Autonomy project as it moves through the onboard processing steps.

Testing
To test from scratch, run the following commands:
ssh itlinux-b(or equivalent machine)git clone git@github.jpl.nasa.gov:SYNOPSIS/synopsis.gitcd synopsis- Proceed with the Setup steps above
For development only: code testing & coverage stats
Note this requires lcov
cmake --build build_covcd build_covctestlcov --capture --directory CMakeFiles/synopsis.dir/src --exclude "*sqlite3*" --output-file coverage.infogenhtml coverage.info --output-directory out- View stats HTML
build_cov/out/index.html
Compiling rule files
The rules files are defined in a human readable form via the .srd files. To prepare these rules for use within SYNOPSIS, they must be converted to a .json representation. To do that, use the srd_to_json.py script as follows:
python synopsis/python/synopsis/srd_to_json.py \
/path/to/my/synposis_rules.srd \
/path/to/my/synposis_rules.json
Architecture Overview
SYNOPSIS is designed to be a modular framework for downlink prioritization to
be incorporated into flight software frameworks such as
F' or cFS.
Users of the SYNOPSIS library instantiate an Application (see synopsis.hpp)
along with a number of modules. Modules include:
- Autonomous Science Data Systems (see
ASDS.hpp) - An Autonomous Science Data Product Database (see
ASDPDB.hpp) - A Downlink Planner (see
DownlinkPlanner.hpp) - A Logger (see
Logger.hpp) - A Clock (see
Clock.hpp)
The ASDSs are registered with an application instance after construction (see
Application::add_asds), whereas the other modules are used during application
construction. After registering ASDSs, the application instance should be
initialized using Application::init. A helper function
Application::memory_requirement specifies how much pre-allocated memory
should be passed to the application for initialization.
After initialization, new data products can be ingested into SYNOPSIS using the
Application::accept_dp function. Data product messages passed to this
function contain information about the data product's origin (i.e., which
instrument produced it), type, location on a filesystem, and metadata location.
Invoking this function will either synchronously or asynchronously (depending
on the design of the ASDS) process the data product to produce an autonomous
science data product (ASDP), which will then be inserted into the ASDP
database (ASDPDB).
SYNOPSIS provides an interface to manually update information in the ASDP DB, which can be invoked via ground commands. These functions are:
Application::update_science_utilityApplication::update_priority_binApplication::update_downlink_stateApplication::update_asdp_metadata
At any time, the user of SYNOPSIS can also invoke the Application::prioritize
function, which will return a prioritized list of ASDPs using a set of
prioritization rules and constraints, along with similarity configuration for
diversity-aware prioritization. This functionality should be invoked prior to
a downlink pass, and the information associated with unique ASDP identifier can
be queried from the ASDP DB to enable transmission to the ground. After
transmission, the downlink state of each transmitted ASDP should be updated so
that subsequent invocations of the Application::prioritize function exclude
these data products.
Finally, when SYNOPSIS functionality is no longer required, the
Application::deinit function can be used to relinquish the use of the memory
provided during application initialization. Initialization and
de-initialization can be performed as often as necessary (i.e., immediately
prior to and after the invocation of one of the functions above that requires
SYNOPSIS to be initialized). One exception is for asynchronous ASDSs; SYNOPSIS
must be initialized when an ASDS returns its result to be submitted to the ASDP
DB.
Acknowledgements
Funding and support for this work was provided by the Multi-mission Ground Systems and Services (MGSS) program office.
Copyright 2023, by the California Institute of Technology. ALL RIGHTS RESERVED. United States Government Sponsorship acknowledged. Any commercial use must be negotiated with the Office of Technology Transfer at the California Institute of Technology.
This software may be subject to U.S. export control laws. By accepting this software, the user agrees to comply with all applicable U.S. export laws and regulations. User has the responsibility to obtain export licenses, or other export authority as may be required before exporting such information to foreign countries or providing access to foreign persons.
Owner
- Name: NASA Advanced Multi-Mission Operations System
- Login: NASA-AMMOS
- Kind: organization
- Location: NASA
- Website: https://ammos.nasa.gov/
- Repositories: 63
- Profile: https://github.com/NASA-AMMOS
Administrator contacts: Aniwat.Nik.Sheurpukdi@jpl.nasa.gov and shawn.n.nguyen@jpl.nasa.gov For AMMOS tech support, please contact the developers.
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Doran" given-names: "Gary" orcid: "https://orcid.org/0000-0003-1233-2224" - family-names: "Wronkiewicz" given-names: "Mark" orcid: "https://orcid.org/0000-0002-6521-3256" - family-names: "Lightholder" given-names: "Jack" orcid: "https://orcid.org/0000-0001-9811-2227" - family-names: "Hasnain" given-names: "Zaki" - family-names: "Stockham" given-names: "Rex" - family-names: "Brown" given-names: "Robert" - family-names: "Zemerick" given-names: "Scott" - family-names: "Mandrake" given-names: "Lukas" orcid: "https://orcid.org/00000-0002-5233-2029" title: "SYNOPSIS: Science Yield improvemeNt via Onboard Prioritization and Summary of Information System" date-released: 2023-10-30 url: "https://github.com/NASA-AMMOS/synopsis/"
GitHub Events
Total
- Watch event: 1
- Issue comment event: 1
Last Year
- Watch event: 1
- Issue comment event: 1
Committers
Last synced: 11 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Mark Wronkiewicz | w****k@g****m | 8 |
| Jack Lightholder | j****r@j****v | 2 |
| NikJPL | 1****L | 1 |
| Mark Wronkiewicz | w****k@j****v | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 1
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 1.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- jpl-jengelke (2)