Hello! This is under construction :) All documentation will live here.
Hopefully this will be a stable, helpful, open source of validated guidance, navigation, dynamics, and control code functionality, all written in Python.
I've got good credentials! --> my linkedin
I'm a big believer in code validation. All functionality in this repo will be validated in the following ways:
- Unit testing: Functions and class methods will be "small" (simplified and testable). All possible code paths will be tested to ensure that they provide expected, deterministic results and don't catastrophically break.
- Simulation testing: For functions that require timing and propagation, I will include example usage and expected results.
- Validation against existing truth data: Wherever possible, functionality will be validated against truth data sources such as STK, GMAT, NASA data, etc.
Yeah, eventually!
Michelle Chernick - it me, pushing directly to main
If you want to use astrochelle as a package, follow the instructions below.
Note: astrochelle was developed using Python 3.6, but the pipeline tests it from 3.6 to 3.10.
- Run
pip3 install -e .
from the root directory.
- Install the requirements via the command
pip3 install -r requirements.txt
The astrochelle repo is organized into the following folders:
Dis dat main shit.
TODO fill in later
TODO fill in later
- propagation
- etc
TODO fill in later
- absolute state
- relative state
- math
- etc
This folder contains configuration and state files for use within the module. For example, the propagator classes in dynamics/propagation are initialized with the GVEPropagatorConfig data model. (Why data models? Because they can inherently include validators to ensure that the user isn't setting trash variables.)
The examples folder contains more detailed examples demonstrating code usage. TODO details on running examples
The test folder contains unit tests. TODO details on running unit tests, details on pipeline