Skip to content

Update README.md #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 30, 2025
Merged

Update README.md #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7855a5a
Update README.md
connor-powers May 30, 2025
969c631
Update cmake_gtest_v2.yml
connor-powers May 30, 2025
0bafea9
Update README.md
connor-powers May 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/cmake_gtest_v2.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ jobs:
- uses: actions/checkout@v4

- name: Install gnuplot
run: sudo apt-get install gnuplot
run: |
sudo apt-get update
sudo apt-get install gnuplot

- name: Run test suites
working-directory: ${{github.workspace}}
Expand Down
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,11 @@

- Continuous (low) thrust maneuvers to change argument of periapsis

- Note: Thrust profiles of argument of periapsis change maneuvers are calculated assuming a "continuous" maneuver takes place (i.e., a burn arc angle $\alpha = \pi/2$ radians in https://apps.dtic.mil/sti/tr/pdf/ADA384536.pdf). Therefore it is not recommended to use this feature outside of parameter ranges where this assumption does not hold. Maneuvers that take place over a fraction of an orbit are not recommended.
- Note: Thrust profiles of argument of periapsis change maneuvers are calculated assuming a "continuous" maneuver takes place (i.e., a burn arc angle $\alpha = \pi/2$ radians in https://apps.dtic.mil/sti/tr/pdf/ADA384536.pdf) with negligible natural drift rate of the argument of periapsis compared to the rate of change due to the maneuver burn. Therefore it is not recommended to use this feature outside of parameter ranges where these assumptions does not hold. Maneuvers that take place over a fraction of an orbit are not recommended.

- Saving simulation data to data files and generating 2D and 3D plots from data files

- Note: Some plotting-related features (e.g., total simulation time in titles, specified plotting colors) are not yet supported when plotting from data files. Legend names also currently reflect data file names instead of satellite names. I intend to further improve plotting from data files.

## SatSim Build + Install Instructions
Note: this tool requires gnuplot to be installed.
Expand Down Expand Up @@ -85,6 +89,8 @@ Calculation of instantaneous orbital angular acceleration does not currently inc

Loss of propellant mass during burns is not yet accounted for.

If saving to data files, make a "data" directory in your project folder.

Visualization/plotting is done via Gnuplot. The copyright and permission notice of Gnuplot is shown below:

Copyright 1986 - 1993, 1998, 2004 Thomas Williams, Colin Kelley
Expand Down