https://github.com/sisl/satellitedynamics.jl
SatelliteDynamics.jl is a satellite dynamics modeling package written for Julia.
https://github.com/sisl/satellitedynamics.jl
Last synced: 9 months ago
JSON representation
SatelliteDynamics.jl is a satellite dynamics modeling package written for Julia.
- Host: GitHub
- URL: https://github.com/sisl/satellitedynamics.jl
- Owner: sisl
- License: mit
- Created: 2018-11-21T06:05:51.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-09-12T09:33:50.000Z (9 months ago)
- Last Synced: 2025-09-12T11:39:19.550Z (9 months ago)
- Language: Julia
- Size: 29.6 MB
- Stars: 63
- Watchers: 16
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# SatelliteDynamics.jl [](https://sisl.github.io/SatelliteDynamics.jl/stable/) [](https://sisl.github.io/SatelliteDynamics.jl/dev/) [](https://github.com/sisl/SatelliteDynamics.jl/actions/workflows/CI.yml?query=branch%3Amain) [](https://codecov.io/gh/sisl/SatelliteDynamics.jl)
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:
1. It is commercially licensed and closed-source code, making it difficult, if not impossible, to be used by hobbyists and academic researchers.
2. 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.
## Getting Started: Installation And First Steps
To install the package, use the following command inside the Julia REPL:
```julia
Pkg.add("SatelliteDynamics")
```
To load the package, use the command:
```julia
using SatelliteDynamics
```
## Documentation
The documentation for the package can be found here:
More example code and more thorough documentation will be added as time permits.
## Contributing
Contributions are welcome!
### Local Development
**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:
```zsh
julia --project
```
```julia
]; 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.