https://github.com/nasa-ammos/aerie-simple-model-data
An Aerie model of data management and a demonstration with a simple mission model
https://github.com/nasa-ammos/aerie-simple-model-data
Last synced: about 1 year ago
JSON representation
An Aerie model of data management and a demonstration with a simple mission model
- Host: GitHub
- URL: https://github.com/nasa-ammos/aerie-simple-model-data
- Owner: NASA-AMMOS
- Created: 2023-10-18T15:48:08.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-03T20:36:54.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T19:54:19.376Z (over 1 year ago)
- Language: Java
- Size: 38.3 MB
- Stars: 0
- Watchers: 18
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aerie-simple-model-data
A reusable multi-mission model of data management for Aerie
This repository provides a simple, configurable spacecraft data management model for use within the [Aerie framework](https://github.com/NASA-AMMOS/aerie). The data model includes basic components to represent a data storage device and categories of data, which can be optionally storage limited and represent types of data, folders, partitions, etc.
See the [model behavior documentation](docs/ModelBehaviorDescription.md) for a description of activities affecting data
volumes and details of how data volumes are calculated in the presence of limits and priorities.
For example, if the total storage limit is reached, lower priority data will be deleted as higher priority data is collected.
## Quick Start
Interested in giving the data model a quick spin? We've pre-built a very simple example spacecraft model, demosystem, that uses the data model. This model has a few activities in it that add and transfer data. To try out this model, simply load [demo.jar](demo.jar) into Aerie. If you have never used Aerie before and need some help getting it deployed and uploading a model, start [here](https://nasa-ammos.github.io/aerie-docs/introduction/#fast-track).
Once you have loaded [demo.jar](demo.jar) into Aerie, make a plan with a time range of your choosing (a plan length of a day should be reasonable). Once you have created a plan, add a couple of activities to it and hit the simulate button. Once the simulation completes you should see a green check appear next to the Simulation icon, and viola, you have successfully run the data model!
Alternatively, you can follow instructions for [loading a sample plan](#loading-a-sample-plan).
To actually see the results of the simulation you ran, you can load a pre-built [basic data model view](DataModelBasicView.json) that will place a number of different resources on to the timeline for named buckets of data.
## Organization
The core data model is in the `model` directory. This is what the mission modeler would integrate into their own spacecraft model if they needed a data model. The `demo` directory contains an example to show how a mission modeler can integrate this data model into their model, specifically by changing their package.info file and their top-level mission class.
The following instructions assume that you are using MacOS, but the instructions for building and running should work on Linux and Windows, too.
## Prerequisites
- Install [OpenJDK Temurin LTS](https://adoptium.net/temurin/releases/?version=19). If you're on macOS, you can install [brew](https://brew.sh/) instead and then use the following command to install JDK 19:
```sh
brew tap homebrew/cask-versions
brew install --cask temurin21
```
Make sure you update your `JAVA_HOME` environment variable. For example with [Zsh](https://www.zsh.org/) you can update your `.zshrc` with:
```sh
export JAVA_HOME="/Library/Java/JavaVirtualMachines/temurin-21.jdk/Contents/Home"
```
- Ensure you have docker installed on your machine. If you do not, install it [here](https://docs.docker.com/desktop/).
- Navigate to a directory on your local machine where you want to keep this repo and clone the repo using the following command:
```sh
git clone https://github.jpl.nasa.gov/MPS/aerie-data-model.git
```
- Set `GITHUB_USER` and `GITHUB_TOKEN` environment variables to your credentials inside this directory (first you need to create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-personal-access-token-classic) in your GitHub account) so you can download the Aerie Maven packages from the [GitHub Maven package registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry). For example with Zsh you can update your `.zshrc` to set the variables with:
```sh
export GITHUB_USER="your github user"
export GITHUB_TOKEN="your github token"
```
## Building
To build the mission model JAR file in the `demo/build/libs` sub-directory of the repository directory and the data model jar in the `model/build/libs` sub-directory, you can type in this command in the directory of the repository:
```sh
./gradlew build --refresh-dependencies
```
You can deploy Aerie on your local machine by first opening Docker Desktop, and then you can start the Aerie services using the following command in the directory of the repository:
```sh
docker compose up -d
```
You can then upload the JAR to Aerie using either the [UI](http://localhost/) or API.
## Testing
To run unit tests under [./src/test](./src/test), you can enter:
```sh
./gradlew test
```
## Loading a Sample Plan
You can use a command line tool for aerie to upload a sample plan. Follow the instructions at
https://github.com/NASA-AMMOS/aerie-cli to install and try out aerie-cli. Before uploading a plan,
get the model id of the mission model jar that you uploaded. Then upload the included
[sample-plan.json](sample-plan.json), issue the following command replacing "1" with the
mission model id you found:
```sh
aerie-cli plans upload -i sample-plan.json -m 1 --time-tag
```
The `--time-tag` option adds a timestamp to the plan name so that multiple uploads don't try to reuse the same name,
which causes and error.
You can then simulate and view with the [basic data model view](DataModelBasicView.json), assuming that you have
already uploaded it as described in the [Quick Start](#quick-start) section above. And you should then see the
simulation results below:
