Adds notebook exhibiting types

JuliaAstro · May 18, 2024 · 4a9e406 · 4a9e406
1 parent 797630f
commit 4a9e406
Show file tree

Hide file tree

Showing 11 changed files with 821 additions and 36 deletions.
diff --git a/lib/AstrodynamicalModels/ext/AstrodynamicalCalculationsExt.jl b/lib/AstrodynamicalModels/ext/AstrodynamicalCalculationsExt.jl
@@ -13,26 +13,42 @@ function AC.keplerian_to_cartesian(state::KeplerianState, μ)
 
     return CartesianState(u)
 end
+AC.keplerian_to_cartesian(orbit::CartesianOrbit) =
+    Orbit(AC.keplerian_to_cartesian(orbit.state, orbit.parameters), orbit.parameters)
 
 function AC.cartesian_to_keplerian(state::CartesianState, μ)
     p = μ isa Number ? R2BParameters(μ) : μ
-    u = AC.cartesian_to_keplerian(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, p.μ)
+    u = AC.cartesian_to_keplerian(
+        state.x,
+        state.y,
+        state.z,
+        state.ẋ,
+        state.ẏ,
+        state.ż,
+        p.μ,
+    )
 
     return KeplerianState(u)
 end
+AC.cartesian_to_keplerian(orbit::CartesianOrbit) =
+    Orbit(AC.cartesian_to_keplerian(orbit.state, orbit.parameters), orbit.parameters)
 
 AC.eccentricity(state::KeplerianState) = state.e
 AC.eccentricity(state::KeplerianState, μ) = AC.eccentricity(state)
-AC.eccentricity(state::CartesianState, μ) = AC.eccentricity(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.eccentricity(state::CartesianState, μ) =
+    AC.eccentricity(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.eccentricity(orbit::Orbit) = AC.eccentricity(orbit.state, orbit.parameters)
 
-AC.eccentricity_vector(state::CartesianState, μ) = AC.eccentricity_vector(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
-AC.eccentricity_vector(state::KeplerianState, μ) = AC.eccentricity_vector(keplerian_to_cartesian(state, μ), μ)
+AC.eccentricity_vector(state::CartesianState, μ) =
+    AC.eccentricity_vector(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.eccentricity_vector(state::KeplerianState, μ) =
+    AC.eccentricity_vector(keplerian_to_cartesian(state, μ), μ)
 AC.eccentricity_vector(orbit::Orbit) = AC.eccentricity_vector(orbit.state, orbit.parameters)
 
 AC.semimajor_axis(state::KeplerianState) = state.a
 AC.semimajor_axis(state::KeplerianState, μ) = AC.semimajor_axis(state)
-AC.semimajor_axis(state::CartesianState, μ) = AC.semimajor_axis(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.semimajor_axis(state::CartesianState, μ) =
+    AC.semimajor_axis(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.semimajor_axis(orbit::Orbit) = AC.semimajor_axis(orbit.state, orbit.parameters)
 
 AC.inclination(state::KeplerianState) = state.i
@@ -41,74 +57,123 @@ AC.inclination(state::CartesianState, μ) = AC.inclination(cartesian_to_kepleria
 AC.inclination(orbit::Orbit) = AC.inclination(orbit.state, orbit.parameters)
 
 AC.right_ascension_ascending_node(state::KeplerianState) = state.Ω
-AC.right_ascension_ascending_node(state::KeplerianState, μ) = AC.right_ascension_ascending_node(state)
-AC.right_ascension_ascending_node(state::CartesianState, μ) = AC.right_ascension_ascending_node(cartesian_to_keplerian(state, μ), gm(μ))
-AC.right_ascension_ascending_node(orbit::Orbit) = AC.right_ascension_ascending_node(orbit.state, orbit.parameters)
+AC.right_ascension_ascending_node(state::KeplerianState, μ) =
+    AC.right_ascension_ascending_node(state)
+AC.right_ascension_ascending_node(state::CartesianState, μ) =
+    AC.right_ascension_ascending_node(cartesian_to_keplerian(state, μ), gm(μ))
+AC.right_ascension_ascending_node(orbit::Orbit) =
+    AC.right_ascension_ascending_node(orbit.state, orbit.parameters)
 
 AC.argument_of_periapsis(state::KeplerianState) = state.ω
 AC.argument_of_periapsis(state::KeplerianState, μ) = AC.argument_of_periapsis(state)
-AC.argument_of_periapsis(state::CartesianState, μ) = AC.argument_of_periapsis(cartesian_to_keplerian(state, μ), gm(μ))
-AC.argument_of_periapsis(orbit::Orbit) = AC.argument_of_periapsis(orbit.state, orbit.parameters)
+AC.argument_of_periapsis(state::CartesianState, μ) =
+    AC.argument_of_periapsis(cartesian_to_keplerian(state, μ), gm(μ))
+AC.argument_of_periapsis(orbit::Orbit) =
+    AC.argument_of_periapsis(orbit.state, orbit.parameters)
 
 AC.true_anomaly(state::KeplerianState) = state.ω
 AC.true_anomaly(state::KeplerianState, μ) = AC.true_anomaly(state)
-AC.true_anomaly(state::CartesianState, μ) = AC.true_anomaly(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.true_anomaly(state::CartesianState, μ) =
+    AC.true_anomaly(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.true_anomaly(orbit::Orbit) = AC.true_anomaly(orbit.state, orbit.parameters)
 
 AC.semi_parameter(state::KeplerianState) = AC.semi_parameter(state.a, state.e)
 AC.semi_parameter(state::KeplerianState, μ) = AC.semi_parameter(state)
-AC.semi_parameter(state::CartesianState, μ) = AC.semi_parameter(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.semi_parameter(state::CartesianState, μ) =
+    AC.semi_parameter(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.semi_parameter(orbit::Orbit) = AC.semi_parameter(orbit.state, orbit.parameters)
 
 AC.specific_energy(state::KeplerianState, μ) = AC.specific_energy(state.a, gm(μ))
-AC.specific_energy(state::CartesianState, μ) = AC.specific_energy(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.specific_energy(state::CartesianState, μ) =
+    AC.specific_energy(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.specific_energy(orbit::Orbit) = AC.specific_energy(orbit.state, orbit.parameters)
 
-AC.specific_potential_energy(state::KeplerianState) = AC.orbital_radius(semi_parameter(state.a, state.e), state.e, state.ν)
+AC.specific_potential_energy(state::KeplerianState) =
+    AC.orbital_radius(semi_parameter(state.a, state.e), state.e, state.ν)
 AC.specific_potential_energy(state::KeplerianState, μ) = AC.specific_potential_energy(state)
-AC.specific_potential_energy(state::CartesianState, μ) = AC.specific_potential_energy(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
-AC.specific_potential_energy(orbit::Orbit) = AC.specific_potential_energy(orbit.state, orbit.parameters)
-
-AC.specific_angular_momentum(state::CartesianState, μ) = AC.specific_angular_momentum(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
-AC.specific_angular_momentum(state::KeplerianState, μ) = AC.specific_angular_momentum(keplerian_to_cartesian(state, μ), μ)
-AC.specific_angular_momentum(orbit::Orbit) = AC.specific_angular_momentum(orbit.state, orbit.parameters)
-
-AC.specific_angular_momentum_vector(state::CartesianState, μ) = AC.specific_angular_momentum_vector(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
-AC.specific_angular_momentum_vector(state::KeplerianState, μ) = AC.specific_angular_momentum_vector(keplerian_to_cartesian(state, μ), μ)
-AC.specific_angular_momentum_vector(orbit::Orbit) = AC.specific_angular_momentum_vector(orbit.state, orbit.parameters)
-
-AC.c3(state::CartesianState, μ) = AC.c3(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.specific_potential_energy(state::CartesianState, μ) = AC.specific_potential_energy(
+    state.x,
+    state.y,
+    state.z,
+    state.ẋ,
+    state.ẏ,
+    state.ż,
+    gm(μ),
+)
+AC.specific_potential_energy(orbit::Orbit) =
+    AC.specific_potential_energy(orbit.state, orbit.parameters)
+
+AC.specific_angular_momentum(state::CartesianState, μ) = AC.specific_angular_momentum(
+    state.x,
+    state.y,
+    state.z,
+    state.ẋ,
+    state.ẏ,
+    state.ż,
+    gm(μ),
+)
+AC.specific_angular_momentum(state::KeplerianState, μ) =
+    AC.specific_angular_momentum(keplerian_to_cartesian(state, μ), μ)
+AC.specific_angular_momentum(orbit::Orbit) =
+    AC.specific_angular_momentum(orbit.state, orbit.parameters)
+
+AC.specific_angular_momentum_vector(state::CartesianState, μ) =
+    AC.specific_angular_momentum_vector(
+        state.x,
+        state.y,
+        state.z,
+        state.ẋ,
+        state.ẏ,
+        state.ż,
+        gm(μ),
+    )
+AC.specific_angular_momentum_vector(state::KeplerianState, μ) =
+    AC.specific_angular_momentum_vector(keplerian_to_cartesian(state, μ), μ)
+AC.specific_angular_momentum_vector(orbit::Orbit) =
+    AC.specific_angular_momentum_vector(orbit.state, orbit.parameters)
+
+AC.c3(state::CartesianState, μ) =
+    AC.c3(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.c3(state::KeplerianState, μ) = AC.c3(keplerian_to_cartesian(state, μ), μ)
 AC.c3(orbit::Orbit) = AC.c3(orbit.state, orbit.parameters)
 
-AC.v_infinity(state::CartesianState, μ) = AC.v_infinity(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.v_infinity(state::CartesianState, μ) =
+    AC.v_infinity(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.v_infinity(state::KeplerianState, μ) = AC.v_infinity(keplerian_to_cartesian(state, μ), μ)
 AC.v_infinity(orbit::Orbit) = AC.v_infinity(orbit.state, orbit.parameters)
 
 AC.orbital_period(state::KeplerianState, μ) = AC.orbital_period(state.a, gm(μ))
-AC.orbital_period(state::CartesianState, μ) = AC.orbital_period(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.orbital_period(state::CartesianState, μ) =
+    AC.orbital_period(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.orbital_period(orbit::Orbit) = AC.orbital_period(orbit.state, orbit.parameters)
 
-AC.orbital_radius(state::KeplerianState, μ) = AC.orbital_radius(AC.semi_parameter(state.a, state.e), state.e, state.ν)
-AC.orbital_radius(state::CartesianState, μ) = AC.orbital_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.orbital_radius(state::KeplerianState, μ) =
+    AC.orbital_radius(AC.semi_parameter(state.a, state.e), state.e, state.ν)
+AC.orbital_radius(state::CartesianState, μ) =
+    AC.orbital_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.orbital_radius(orbit::Orbit) = AC.orbital_radius(orbit.state, orbit.parameters)
 
-AC.orbital_speed(state::KeplerianState, μ) = AC.orbital_speed(AC.orbital_radius(state, μ), state.a, gm(μ))
-AC.orbital_speed(state::CartesianState, μ) = AC.orbital_speed(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.orbital_speed(state::KeplerianState, μ) =
+    AC.orbital_speed(AC.orbital_radius(state, μ), state.a, gm(μ))
+AC.orbital_speed(state::CartesianState, μ) =
+    AC.orbital_speed(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.orbital_speed(orbit::Orbit) = AC.orbital_speed(orbit.state, orbit.parameters)
 
 AC.mean_motion(state::KeplerianState, μ) = AC.mean_motion(state.a, gm(μ))
-AC.mean_motion(state::CartesianState, μ) = AC.mean_motion(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.mean_motion(state::CartesianState, μ) =
+    AC.mean_motion(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.mean_motion(orbit::Orbit) = AC.mean_motion(orbit.state, orbit.parameters)
 
 AC.apoapsis_radius(state::KeplerianState) = AC.apoapsis_radius(state.a, state.e)
 AC.apoapsis_radius(state::KeplerianState, μ) = AC.apoapsis_radius(state)
-AC.apoapsis_radius(state::CartesianState, μ) = AC.apoapsis_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.apoapsis_radius(state::CartesianState, μ) =
+    AC.apoapsis_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.apoapsis_radius(orbit::Orbit) = AC.apoapsis_radius(orbit.state, orbit.parameters)
 
 AC.periapsis_radius(state::KeplerianState) = AC.periapsis_radius(state.a, state.e)
 AC.periapsis_radius(state::KeplerianState, μ) = AC.periapsis_radius(state)
-AC.periapsis_radius(state::CartesianState, μ) = AC.periapsis_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
+AC.periapsis_radius(state::CartesianState, μ) =
+    AC.periapsis_radius(state.x, state.y, state.z, state.ẋ, state.ẏ, state.ż, gm(μ))
 AC.periapsis_radius(orbit::Orbit) = AC.periapsis_radius(orbit.state, orbit.parameters)
 
 AC.conic(state::KeplerianState) = AC.conic(state.e)
@@ -117,7 +182,10 @@ AC.conic(state::CartesianState, μ) = AC.conic(AC.eccentricity(state, μ))
 AC.conic(orbit::Orbit) = AC.conic(orbit.state, orbit.parameters)
 
 function Base.show(io::IO, ::MIME"text/plain", orbit::Union{<:R2BOrbit,<:KeplerianOrbit})
-    println(io, "$(AC.conic(orbit)) Orbit in $(AstrodynamicalModels.paradigm(orbit.parameters))\n")
+    println(
+        io,
+        "$(AC.conic(orbit)) Orbit in $(AstrodynamicalModels.paradigm(orbit.parameters))\n",
+    )
 
     for line in eachline(IOBuffer(string(orbit.state)))
         println(io, "  ", line)

diff --git a/paper/.gitignore b/paper/.gitignore
@@ -0,0 +1,143 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# MacOs
+.DS_Store
+
+# Quarto
+/.quarto/
+_site
+_manuscript
+site_libs
+*.sty
+*index_files*
+*.jats
+*.pdf
+*.docx
diff --git a/paper/CNAME b/paper/CNAME
@@ -0,0 +1 @@
+astrodynamics.loopy.codes
diff --git a/paper/Project.toml b/paper/Project.toml
@@ -0,0 +1,13 @@
+[deps]
+CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
+GeneralAstrodynamics = "8068df5b-8501-4530-bd82-d24d3c9619db"
+HorizonsAPI = "c15253bb-5e94-4b8b-9a02-579bb6c8e3ce"
+HorizonsEphemeris = "05ee1981-f730-42d8-b713-4f42d99733dc"
+IJulia = "7073ff75-c697-5162-941a-fcdaad2a7d2a"
+Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
+SPICE = "5bab7191-041a-5c2e-a744-024b9c3a5062"
+SPICEApplications = "e12e0822-0612-48d4-a4bb-92984dd6b6ec"
+SPICEBodies = "19f1efb6-7162-484a-b3a1-b52c391689d7"
+SPICEKernels = "8e9d28ce-e483-4ef7-bfd9-45b8fef6369c"