Aerie Simple Power Model

This repository provides a simple, configurable spacecraft power model for use within the Aerie framework. The power model includes basic components to represent a power source (e.g. solar arrays), spacecraft power loads (represented as a power equipment list), and energy storage (e.g. battery). A detailed description of the equations and variables that drive the model behavior is available here.

Quick Start

Interested in giving the power model a quick spin? We've pre-built a very simple example spacecraft model, demosystem, that uses the power model. This model has a few activities in it that turn on/off various spacecraft loads. To try out this model, simply load demosystem.jar into Aerie. If you have never used Aerie before and need some help getting it deployed and uploading a model, start here. Or, if you already have Docker installed, you should be able to start up Aerie by navigating to the top directory of this repo and issuing the following command.

 docker compose up

Once you have loaded demosystem.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 (e.g. TurnOnCamera) and hit the simulate button. Once the simulation completes you should see a green check appear next to the Simulation icon and timelines populate in the view below. Viola! You have successfully run the power model!

To see the results of the simulation you ran in a slightly more organized manner, you can load a pre-built basic power model view that will order a subset of the resources on to the timeline for (power load, battery state of charge, etc.).

There are number of configuration variables available in the "Simulation" pane that you can adjust to produce different behavior with the power model. Feel free to play around with these configurations and re-simulate to see how the results change.

Organization

The core power model is in the power system package in this repo. This is what the mission modeler would integrate into their own spacecraft model if they needed a power model. The demosystem package in this repo is an example to show how a mission modeler can integrate this power model into their model, specifically by changing their package.info file and their top-level mission class.

Power Equipment List (PEL)

Example activities within the demosystem package effect the power model by making state or load changes on hardware defined within the PEL Model Package. A simple python script, pel_java_generator.py, included in this repo can generate all of the files within that package for you based on the pel.json file. If you want to add new/different loads, just updated the power_loads property in that file.

Prerequisites

Install OpenJDK Temurin LTS. If you're on macOS, you can install brew instead and then use the following command to install JDK 21:
```
brew install --cask temurin@21
```
First you need to create a personal access token in your GitHub account that includes read-packages scope) so you can download the Aerie Maven packages from the GitHub Maven package registry.

Then, copy the .env.template file to .env. This .env file will hold your GITHUB_TOKEN and GITHUB_USER variables. Note that this file is ".gitignored" by default, so edits to this file won't be tracked in version control.

Open up .env and fill in the just the missing variables with your Github information:
```
# in .env file
GITHUB_USER="your_github_username_here"
GITHUB_TOKEN="your_personal_access_token"
```

Building

To build a mission model JAR you can do:

./gradlew :missionmodel:build --refresh-dependencies

This will create the file 'missionmodel/build/libs/missionmodel.jar, which you can upload to Aerie using the UI or API.

Testing

To run unit tests under ./missionmodel/src/test against your mission model you can do:

./gradlew :missionmodel:test