{"id":18265174,"url":"https://github.com/nasa-ammos/synopsis","last_synced_at":"2025-04-12T00:15:16.979Z","repository":{"id":94648255,"uuid":"585659566","full_name":"NASA-AMMOS/synopsis","owner":"NASA-AMMOS","description":"Science Yield improvemeNt via Onboard  Prioritization and Summary of Information System (SYNOPSIS)","archived":false,"fork":false,"pushed_at":"2024-09-03T18:31:47.000Z","size":11486,"stargazers_count":3,"open_issues_count":2,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-12T00:15:03.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NASA-AMMOS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-05T18:34:55.000Z","updated_at":"2025-01-08T16:13:59.000Z","dependencies_parsed_at":"2024-11-05T11:17:25.333Z","dependency_job_id":null,"html_url":"https://github.com/NASA-AMMOS/synopsis","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fsynopsis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fsynopsis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fsynopsis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NASA-AMMOS%2Fsynopsis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NASA-AMMOS","download_url":"https://codeload.github.com/NASA-AMMOS/synopsis/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497818,"owners_count":21113984,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T11:17:21.844Z","updated_at":"2025-04-12T00:15:16.939Z","avatar_url":"https://github.com/NASA-AMMOS.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"SYNOPSIS: Science Yield improvemeNt via Onboard Prioritization and Summary of Information System\n================================================================================================\n\nSYNOPSIS is a system to prioritize the downlink of data products, including\nboth raw data products as well as \"autonomous science data products\" that are\nextracted onboard the spacecraft to summarize data.\n\n## Team\n - Mark Wronkiewicz\n - Gary Doran\n - Jack Lightholder\n - Zaki Hasnain\n - Rex Stockham\n - Robert Brown (JSTAR team at NASA IV\u0026V)\n - Scott Zemerick (JSTAR team at NASA IV\u0026V)\n - Lukas Mandrake\n\n## Building SYNOPSIS\n\n1. Run `cmake -S . -B build` to set up the build directory\n2. Run `cmake --build build` to build the code\n3. Run `cd build \u0026\u0026 ctest` to execute the tests\n\n## SYNOPSIS Integration into cFS\nSee the [core Flight Software (cFS) README file](cfs_integration/README.md) for instructions on building SYNOPSIS in support of a cFS app.\n\n### YouTube: Integration demo with [NOS3](http://www.stf1.com/NOS3Website/Nos3MainTab.php)\nClick 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](https://iopscience.iop.org/article/10.3847/PSJ/ad0227) as it moves through the onboard processing steps.\n[![YouTube](http://i.ytimg.com/vi/41cvM5iSn2Y/hqdefault.jpg)](https://www.youtube.com/watch?v=41cvM5iSn2Y)\n\n## Testing\n\nTo test from scratch, run the following commands:\n\n1. `ssh itlinux-b` (or equivalent machine)\n2. `git clone git@github.jpl.nasa.gov:SYNOPSIS/synopsis.git`\n3. `cd synopsis`\n4. Proceed with the Setup steps above\n\n## For development only: code testing \u0026 coverage stats\n\nNote this requires `lcov`\n\n1. `cmake --build build_cov`\n2. `cd build_cov`\n3. `ctest`\n4. `lcov --capture --directory CMakeFiles/synopsis.dir/src --exclude \"*sqlite3*\" --output-file coverage.info`\n5. `genhtml coverage.info --output-directory out`\n6. View stats HTML `build_cov/out/index.html`\n\n## Compiling rule files\nThe 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:\n```\npython synopsis/python/synopsis/srd_to_json.py \\\n/path/to/my/synposis_rules.srd \\\n/path/to/my/synposis_rules.json\n```\n\n## Architecture Overview\n\nSYNOPSIS is designed to be a modular framework for downlink prioritization to\nbe incorporated into flight software frameworks such as\n[F'](https://nasa.github.io/fprime/) or [cFS](https://cfs.gsfc.nasa.gov/).\nUsers of the SYNOPSIS library instantiate an `Application` (see `synopsis.hpp`)\nalong with a number of modules. Modules include:\n\n - Autonomous Science Data Systems (see `ASDS.hpp`)\n - An Autonomous Science Data Product Database (see `ASDPDB.hpp`)\n - A Downlink Planner (see `DownlinkPlanner.hpp`)\n - A Logger (see `Logger.hpp`)\n - A Clock (see `Clock.hpp`)\n\nThe ASDSs are registered with an application instance after construction (see\n`Application::add_asds`), whereas the other modules are used during application\nconstruction. After registering ASDSs, the application instance should be\ninitialized using `Application::init`. A helper function\n`Application::memory_requirement` specifies how much pre-allocated memory\nshould be passed to the application for initialization.\n\nAfter initialization, new data products can be ingested into SYNOPSIS using the\n`Application::accept_dp` function. Data product messages passed to this\nfunction contain information about the data product's origin (i.e., which\ninstrument produced it), type, location on a filesystem, and metadata location.\nInvoking this function will either synchronously or asynchronously (depending\non the design of the ASDS) process the data product to produce an autonomous\nscience data product (ASDP), which will then be inserted into the ASDP\ndatabase (ASDPDB).\n\nSYNOPSIS provides an interface to manually update information in the ASDP DB,\nwhich can be invoked via ground commands. These functions are:\n\n - `Application::update_science_utility`\n - `Application::update_priority_bin`\n - `Application::update_downlink_state`\n - `Application::update_asdp_metadata`\n\nAt any time, the user of SYNOPSIS can also invoke the `Application::prioritize`\nfunction, which will return a prioritized list of ASDPs using a set of\nprioritization rules and constraints, along with similarity configuration for\ndiversity-aware prioritization. This functionality should be invoked prior to\na downlink pass, and the information associated with unique ASDP identifier can\nbe queried from the ASDP DB to enable transmission to the ground. After\ntransmission, the downlink state of each transmitted ASDP should be updated so\nthat subsequent invocations of the `Application::prioritize` function exclude\nthese data products.\n\nFinally, when SYNOPSIS functionality is no longer required, the\n`Application::deinit` function can be used to relinquish the use of the memory\nprovided during application initialization. Initialization and\nde-initialization can be performed as often as necessary (i.e., immediately\nprior to and after the invocation of one of the functions above that requires\nSYNOPSIS to be initialized). One exception is for asynchronous ASDSs; SYNOPSIS\nmust be initialized when an ASDS returns its result to be submitted to the ASDP\nDB.\n\n## Acknowledgements\n\nFunding and support for this work was provided by the Multi-mission Ground\nSystems and Services (MGSS) program office.\n\nCopyright 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.\n\nThis 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-ammos%2Fsynopsis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnasa-ammos%2Fsynopsis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnasa-ammos%2Fsynopsis/lists"}