SatelliteDynamics package is meant to address the needs of the satellite operator, academic researcher, and public enthusiast communities.
Current high-fidelity satellite dynamics modeling software generally falls into two camps:
- It is commercially licensed and closed-source code, making it difficult, if not impossible, to be used by hobbyists and academic researchers.
- There is a steep learning curve which makes correct use of the underlying libraries difficult.
These two challenges make it an unfortunately common occurance that guidance, navigation, and control engineers will frequently reimplement common astrodynamics libraries for each new project.
With these two deficienties in mind, SatelliteDynamics.jl aims to provide a open-source, MIT-licensed, high fidelity astrodynamics toolbox to help make it easy to perform high-quality simulation and analysis of satellite attitude and orbit dynamics.
To install the package, use the following command inside the Julia REPL:
Pkg.add("SatelliteDynamics")
To load the package, use the command:
using SatelliteDynamics
The documentation for the package can be found here: https://sisl.github.io/SatelliteDynamics.jl/latest
More example code and more thorough documentation will be added as time permits.
Contributions are welcome!
Running Unit Tests
The package has a suite of unit tests that can be run using the following command:
julia --project -e 'using Pkg; Pkg.test("SatelliteDynamics")'
Or alternatively, you can run the tests from the package REPL:
julia --project
]; test
Building the Documentation
To build the documentation locally, you can use the following command:
cd docs
Then
julia --project make.jl
The documentation will be built in the docs/build
directory and can be viewed by opening the index.html
file in a web browser.