diff --git a/.gitignore b/.gitignore index 253e46260..7bdc11c7c 100755 --- a/.gitignore +++ b/.gitignore @@ -41,6 +41,11 @@ coverage/ docs/html/ docs/latex/ +docs/xml/ +docs/_autosummary +docs/_build +docs/_notebooks +docs/cpp_rst ## Misc. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index eeedc7383..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing - -For the contributing guide, please consult the CONTRIBUTING.md in the [open-space-toolkit](https://github.com/open-space-collective/open-space-toolkit) base repo [here](https://github.com/open-space-collective/open-space-toolkit/blob/main/CONTRIBUTING.md). diff --git a/Makefile b/Makefile index 70750b667..cc4c9b732 100644 --- a/Makefile +++ b/Makefile @@ -188,8 +188,21 @@ build-documentation-standalone: ## Build documentation (standalone) --volume="/app/build" \ --workdir=/app/build \ $(docker_development_image_repository):$(docker_image_version) \ - /bin/bash -c "cmake -DBUILD_UNIT_TESTS=OFF -DBUILD_BENCHMARK=OFF -DBUILD_VALIDATION_TESTS=OFF -DBUILD_PYTHON_BINDINGS=OFF -DBUILD_DOCUMENTATION=ON .. \ - && $(MAKE) docs" + /bin/bash -c "cmake -DBUILD_UNIT_TESTS=OFF -DBUILD_BENCHMARK=OFF -DBUILD_VALIDATION_TESTS=OFF -DBUILD_PYTHON_BINDINGS=ON -DBUILD_DOCUMENTATION=ON .. \ + && ostk-build \ + && ostk-install-python \ + && pip install -r /app/docs/requirements.txt \ + && mkdir -p /app/docs/_notebooks \ + && cd /app/docs/_notebooks \ + && git init \ + && git remote add origin https://github.com/open-space-collective/open-space-toolkit \ + && git config core.sparseCheckout true \ + && echo "notebooks/Astrodynamics/*" >> .git/info/sparse-checkout \ + && git pull origin main \ + && find . -type f -name "*.ipynb" -exec mv {} . \; \ + && cd /app/docs \ + && breathe-apidoc -o cpp_rst xml -g class \ + && sphinx-build -j 4 -b html . _build/html" .PHONY: build-documentation-standalone diff --git a/README.md b/README.md index 9a141588b..acd9962e4 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![PyPI version](https://badge.fury.io/py/open-space-toolkit-astrodynamics.svg)](https://badge.fury.io/py/open-space-toolkit-astrodynamics) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -Orbit, attitude, access. +Orbit, attitude, access, mission analysis. @@ -98,10 +98,7 @@ pip install open-space-toolkit-astrodynamics ## Documentation -Documentation is available here: - -- [C++](https://open-space-collective.github.io/open-space-toolkit-astrodynamics) -- [Python](./bindings/python/docs) +Documentation is available [here](https://open-space-collective.github.io/open-space-toolkit-astrodynamics):
Structure @@ -157,8 +154,8 @@ The library exhibits the following detailed and descriptive structure: Tutorials are available here: -- [C++](./tutorials/cpp) -- [Python](./tutorials/python) +- C++ (in progress) +- [Python](https://github.com/open-space-collective/open-space-toolkit/tree/main/notebooks) ## Setup @@ -339,7 +336,7 @@ The validation tests can be run with `ostk-validate` from within the dev contain Contributions are more than welcome! -Please read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose fixes and improvements, and how to build and test the code. +For the contributing guide, please consult the CONTRIBUTING.md in the [open-space-toolkit](https://github.com/open-space-collective/open-space-toolkit) base repo [here](https://github.com/open-space-collective/open-space-toolkit/blob/main/CONTRIBUTING.md). ## Special Thanks diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy.cxx b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy.cxx index 75cac3df5..0e138bca0 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy.cxx +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy.cxx @@ -23,9 +23,6 @@ PYBIND11_MODULE(OpenSpaceToolkitAstrodynamicsPy, m) // Add optional docstring for package OpenSpaceToolkitAstrodynamicsPy m.doc() = "Orbit, attitude, access for OpenSpaceToolkit"; - // Add __path__ attribute to python package - m.attr("__path__") = "ostk.astrodynamics"; - // Change attribute __name__ to make OpenSpaceToolkitAstrodynamicsPy invisible in modules path m.attr("__name__") = "ostk.astrodynamics"; diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access.cpp index 7be663986..ecd95ff5e 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Access(pybind11::module& aModule) This class encapsulates the concept of visibility access between two trajectories. - Group: - access )doc" ); @@ -199,9 +197,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Access(pybind11::module& aModule) // Create "access" python submodule auto access = aModule.def_submodule("access"); - // Add __path__ attribute for "access" submodule - access.attr("__path__") = "ostk.astrodynamics.access"; - // Add elements to "access" module OpenSpaceToolkitAstrodynamicsPy_Access_Generator(access); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access/Generator.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access/Generator.cpp index e84ff4011..0ff5d40c4 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access/Generator.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Access/Generator.cpp @@ -25,9 +25,7 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Access_Generator(pybind11::module& a "Generator", R"doc( An access generator. - - Group: - access + )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction.cpp index 982898e5c..5a6467d0c 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction.cpp @@ -7,9 +7,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction(pybind11::module& aModul // Create "conjunction" python submodule auto conjunction = aModule.def_submodule("conjunction"); - // Add __path__ attribute for "conjunction" submodule - conjunction.attr("__path__") = "ostk.astrodynamics.conjunction"; - // Add objects to "conjunction" submodule OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages(conjunction); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages.cpp index 35ed717e5..8ba6ee5f0 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages.cpp @@ -7,9 +7,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages(pybind11::modul // Create "messages" python submodule auto messages = aModule.def_submodule("messages"); - // Add __path__ attribute for "messages" submodule - messages.attr("__path__") = "ostk.astrodynamics.conjunction.messages"; - // Add objects to "messages" submodule OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS(messages); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS.cpp index 1d70ca167..6282bbfeb 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS.cpp @@ -7,9 +7,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS(pybind11: // Create "ccsds" python submodule auto ccsds = aModule.def_submodule("ccsds"); - // Add __path__ attribute for "ccsds" submodule - ccsds.attr("__path__") = "ostk.astrodynamics.conjunction.messages.ccsds"; - // Add objects to "ccsds" submodule OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(ccsds); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS/CDM.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS/CDM.cpp index 5ce767bf5..72ccb5704 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS/CDM.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Conjunction/Messages/CCSDS/CDM.cpp @@ -34,8 +34,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(pybin Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf - Group: - ccsds )doc" ); @@ -359,8 +357,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(pybin Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf - Group: - ccsds )doc" ) @@ -439,8 +435,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(pybin Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf - Group: - ccsds )doc" ) @@ -625,8 +619,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(pybin Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf - Group: - ccsds )doc" ) @@ -871,8 +863,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Conjunction_Messages_CCSDS_CDM(pybin Ref: https://public.ccsds.org/Pubs/508x0b1e2s.pdf - Group: - ccsds )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics.cpp index 9c799c36f..609c68400 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics.cpp @@ -83,8 +83,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics(pybind11::module& aModule) - compute_contribution to create a custom dynamics class - Group: - dynamics )doc" ) @@ -188,9 +186,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics(pybind11::module& aModule) // Create "dynamics" python submodule auto dynamics = aModule.def_submodule("dynamics"); - // Add __path__ attribute for "dynamics" submodule - dynamics.attr("__path__") = "ostk.astrodynamics.dynamics"; - // Add objects to "dynamics" submodule OpenSpaceToolkitAstrodynamicsPy_Dynamics_PositionDerivative(dynamics); OpenSpaceToolkitAstrodynamicsPy_Dynamics_CentralBodyGravity(dynamics); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/AtmosphericDrag.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/AtmosphericDrag.cpp index a832ac397..406415bb5 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/AtmosphericDrag.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/AtmosphericDrag.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_AtmosphericDrag(pybind11::m R"doc( The atmospheric drag dynamics. - Group: - dynamics )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/CentralBodyGravity.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/CentralBodyGravity.cpp index 69510f965..be65ceb6d 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/CentralBodyGravity.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/CentralBodyGravity.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_CentralBodyGravity(pybind11 R"doc( The central-body gravity model. - Group: - dynamics )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/PositionDerivative.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/PositionDerivative.cpp index 0ced01e8f..bfc48210a 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/PositionDerivative.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/PositionDerivative.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_PositionDerivative(pybind11 R"doc( The position derivative model. - Group: - dynamics )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Tabulated.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Tabulated.cpp index ea6261cb3..fd90036b8 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Tabulated.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Tabulated.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_Tabulated(pybind11::module& R"doc( The tabulated dynamics. - Group: - dynamics )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/ThirdBodyGravity.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/ThirdBodyGravity.cpp index 1db46eba3..4221cc991 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/ThirdBodyGravity.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/ThirdBodyGravity.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_ThirdBodyGravity(pybind11:: R"doc( The third body gravity model. - Group: - dynamics )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Thruster.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Thruster.cpp index ccf261d3a..010352634 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Thruster.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Dynamics/Thruster.cpp @@ -74,8 +74,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Dynamics_Thruster(pybind11::module& Base class to derive other thruster classes from. Cannot be instantiated. - Group: - dynamics )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition.cpp index 527f062eb..634d4af68 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition.cpp @@ -46,8 +46,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition(pybind11::module& aMo R"doc( An Event Condition defines a criterion that can be evaluated based on a current/previous state vectors and times - Group: - event-condition )doc" ); @@ -57,8 +55,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition(pybind11::module& aMo R"doc( The Event Condition Target. - Group: - event-condition )doc" ); @@ -260,9 +256,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition(pybind11::module& aMo // Create "event_condition" python submodule auto event_condition = aModule.def_submodule("event_condition"); - // Add __path__ attribute for "event_condition" submodule - event_condition.attr("__path__") = "ostk.astrodynamics.event_condition"; - OpenSpaceToolkitAstrodynamicsPy_EventCondition_RealCondition(event_condition); OpenSpaceToolkitAstrodynamicsPy_EventCondition_BooleanCondition(event_condition); OpenSpaceToolkitAstrodynamicsPy_EventCondition_AngularCondition(event_condition); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/AngularCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/AngularCondition.cpp index 343e87cb0..2b4105e27 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/AngularCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/AngularCondition.cpp @@ -27,8 +27,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_AngularCondition(pybi R"doc( An Angular Event Condition. - Group: - event-condition )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/BooleanCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/BooleanCondition.cpp index cfbdb8e5f..118b91547 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/BooleanCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/BooleanCondition.cpp @@ -24,8 +24,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_BooleanCondition(pybi R"doc( A Boolean Event Condition. - Group: - event-condition )doc" ) @@ -40,8 +38,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_BooleanCondition(pybi evaluator (function): The evaluator of the condition. is_inverse (bool): Whether the condition is inverse. - Group: - Constructors )doc", arg("name"), arg("criterion"), diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/COECondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/COECondition.cpp index 64a578486..d8eece528 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/COECondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/COECondition.cpp @@ -24,8 +24,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_COECondition(pybind11 R"doc( A COE Event Condition. - Group: - event-condition )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/InstantCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/InstantCondition.cpp index ebc0da019..a063cd081 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/InstantCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/InstantCondition.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_InstantCondition(pybi R"doc( An Instant Event Condition. - Group: - event-condition )doc" ) @@ -34,8 +32,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_InstantCondition(pybi criterion (Criterion): The criterion. instant (Instant): The instant. - Group: - Constructors )doc", arg("criterion"), arg("instant") @@ -50,8 +46,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_InstantCondition(pybi Returns: Instant: The instant. - Group: - Methods )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/LogicalCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/LogicalCondition.cpp index fa7f8dbaf..21b545018 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/LogicalCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/LogicalCondition.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_LogicalCondition(pybi R"doc( A Logical Event Condition. This class is used to combine multiple event conditions into a single set. - Group: - event-condition )doc" ); @@ -54,8 +52,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_LogicalCondition(pybi type (Type): The type of the logical condition. event_conditions (list[EventCondition]): The list of event conditions. - Group: - Constructors )doc", arg("name"), arg("type"), diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/RealCondition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/RealCondition.cpp index 98caf6d3b..abfe815bb 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/RealCondition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/EventCondition/RealCondition.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_EventCondition_RealCondition(pybind1 R"doc( A Real Event Condition. - Group: - event-condition )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight.cpp index 675ecdd70..0ae25438f 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight.cpp @@ -8,9 +8,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight(pybind11::module& aModule) // Create "flight" python submodule auto flight = aModule.def_submodule("flight"); - // Add __path__ attribute for "flight" submodule - flight.attr("__path__") = "ostk.astrodynamics.flight"; - // Add objects to "flight" submodule OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(flight); OpenSpaceToolkitAstrodynamicsPy_Flight_System(flight); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp index 28d44d764..b8fe57c9d 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(pybind11::module& aMo R"doc( Spacecraft Flight Profile. - Group: - profile )doc" ) @@ -165,9 +163,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile(pybind11::module& aMo // Create "profile" python submodule auto profile = aModule.def_submodule("profile"); - // Add __path__ attribute for "profile" submodule - profile.attr("__path__") = "ostk.astrodynamics.flight.profile"; - // Add objects to "profile" submodule OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_State(profile); OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Model(profile); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp index 298d520dc..5b7b8ce4c 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Model.cpp @@ -14,8 +14,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Model(pybind11::modul R"doc( A flight profile model. - Group: - profile )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models.cpp index c8f50fac9..96e3c958d 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models.cpp @@ -8,9 +8,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Models(pybind11::modu // Create "models" python submodule auto models = aModule.def_submodule("models"); - // Add __path__ attribute for "models" submodule - models.attr("__path__") = "ostk.astrodynamics.flight.profile.models"; - // add objects to "models" submodule OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Models_Transform(models); OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Models_Tabulated(models); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Tabulated.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Tabulated.cpp index dd644e6e0..0fa354d60 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Tabulated.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Tabulated.cpp @@ -18,8 +18,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Models_Tabulated(pybi R"doc( A flight profile model defined by a set of states. - Group: - profile )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Transform.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Transform.cpp index 61893c43f..b1be95a73 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Transform.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/Models/Transform.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_Models_Transform(pybi R"doc( A flight profile model defined by a transform. - Group: - profile )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/State.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/State.cpp index c7a7a4c0f..216954f8d 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/State.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/Profile/State.cpp @@ -24,8 +24,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_Profile_State(pybind11::modul R"doc( Flight profile state. - Group: - profile )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System.cpp index 5e10012cb..58761e2ba 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System.cpp @@ -27,8 +27,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System(pybind11::module& aMod .. warning:: This class is an abstract class and cannot be instantiated. - Group: - system )doc" ) @@ -105,9 +103,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System(pybind11::module& aMod // Create "system" python submodule auto system = aModule.def_submodule("system"); - // Add __path__ attribute for "system" submodule - system.attr("__path__") = "ostk.astrodynamics.flight.system"; - // Add objects to "system" submodule OpenSpaceToolkitAstrodynamicsPy_Flight_System_PropulsionSystem(system); OpenSpaceToolkitAstrodynamicsPy_Flight_System_SatelliteSystem(system); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/PropulsionSystem.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/PropulsionSystem.cpp index 089f73306..6deea23cd 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/PropulsionSystem.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/PropulsionSystem.cpp @@ -23,8 +23,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System_PropulsionSystem(pybin R"doc( A propulsion system. - Group: - system )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystem.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystem.cpp index f43b56a42..c6592b6ee 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystem.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystem.cpp @@ -24,8 +24,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System_SatelliteSystem(pybind R"doc( A Satellite System. - Group: - system )doc" ) @@ -38,13 +36,11 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System_SatelliteSystem(pybind Args: mass (Mass): The mass of the satellite system. satellite_geometry (Composite): The geometry of the satellite system. - inertia_tensor (Matrix3d): The inertia tensor of the satellite system. + inertia_tensor (np.ndarray): The inertia tensor of the satellite system. cross_sectional_surface_area (float): The cross-sectional surface area of the satellite system. drag_coefficient (float): The drag coefficient of the satellite system. propulsion_system (PropulsionSystem): The propulsion system of the satellite system. - Group: - Constructors )doc", arg("mass"), arg("satellite_geometry"), diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystemBuilder.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystemBuilder.cpp index 4ef5554a8..34886b694 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystemBuilder.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Flight/System/SatelliteSystemBuilder.cpp @@ -27,13 +27,17 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System_SatelliteSystemBuilder you to only specify the parameters you want. There are two ways of doing this: Chaining together your desired parameters like so: - SatelliteSystemBuilder().with_dry_mass(X).with_area(Y) + + .. code-block:: python + + satellite_system = SatelliteSystemBuilder().with_dry_mass(X).with_area(Y).build() Using the default SatelliteSystem and changing one parameters like so: - SatelliteSystemBuilder.default().with_dry_mass(X) - Group: - system + .. code-block:: python + + satellite_system = SatelliteSystemBuilder.default().with_dry_mass(X) + )doc" ) @@ -42,8 +46,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Flight_System_SatelliteSystemBuilder R"doc( Constructor. - Group: - Constructors )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw.cpp index a06cfb1ef..1739b545c 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw.cpp @@ -64,8 +64,6 @@ void OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw(pybind11::module& aModule) A guidance law is a mathematical model that computes the acceleration based on specific guidance law logic. - Group: - guidance-law )doc" ) .def( @@ -119,9 +117,6 @@ void OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw(pybind11::module& aModule) // Create "guidance_law" python submodule auto guidance_law = aModule.def_submodule("guidance_law"); - // Add __path__ attribute for "guidance_law" submodule - guidance_law.attr("__path__") = "ostk.astrodynamics.guidance_law"; - // Add objects to "guidance_law" submodule OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw_ConstantThrust(guidance_law); OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw_QLaw(guidance_law); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/ConstantThrust.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/ConstantThrust.cpp index 3d9161fa0..95b2799b6 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/ConstantThrust.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/ConstantThrust.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw_ConstantThrust(pybind11: R"doc( Constant Thrust, Constant Direction dynamics. - Group: - dynamics )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/QLaw.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/QLaw.cpp index 40a2cd2a5..d295efa5c 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/QLaw.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/GuidanceLaw/QLaw.cpp @@ -28,17 +28,15 @@ void OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw_QLaw(pybind11::module& aModule) R"doc( This class implements the Q-law guidance law. - Ref: https://dataverse.jpl.nasa.gov/api/access/datafile/10307?gbrecs=true - Ref: https://www.researchgate.net/publication/370849580_Analytic_Calculation_and_Application_of_the_Q-Law_Guidance_Algorithm_Partial_Derivatives - Ref for derivations: https://dataverse.jpl.nasa.gov/api/access/datafile/13727?gbrecs=true + - Ref: https://dataverse.jpl.nasa.gov/api/access/datafile/10307?gbrecs=true + - Ref: https://www.researchgate.net/publication/370849580_Analytic_Calculation_and_Application_of_the_Q-Law_Guidance_Algorithm_Partial_Derivatives + - Ref for derivations: https://dataverse.jpl.nasa.gov/api/access/datafile/13727?gbrecs=true The Q-law is a Lyapunov feedback control law developed by Petropoulos, based on analytic expressions for maximum rates of change of the orbit elements and the desired changes in the elements. Q, the proximity quotient, serves as a candidate Lyapunov function. As the spacecraft approaches the target orbit, Q decreases monotonically (becoming zero at the target orbit). - Group: - guidance-law )doc" ) @@ -49,8 +47,6 @@ void OpenSpaceToolkitAstrodynamicsPy_GuidanceLaw_QLaw(pybind11::module& aModule) R"doc( Q-law parameters. - Group: - guidance-law )doc" ) .def_readonly( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/RootSolver.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/RootSolver.cpp index 85396d927..8fdee6df7 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/RootSolver.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/RootSolver.cpp @@ -19,8 +19,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_RootSolver(pybind11::module& aModule R"doc( A root solver is an algorithm for finding a zero-crossing of a function. - Group: - solvers )doc" ); @@ -30,8 +28,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_RootSolver(pybind11::module& aModule R"doc( A root solver solution. - Group: - solvers )doc" ) .def_readwrite( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers.cpp index b4d8e14f7..989fef676 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers.cpp @@ -8,9 +8,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Solvers(pybind11::module& aModule) // Create "solvers" python submodule auto solvers = aModule.def_submodule("solvers"); - // Add __path__ attribute for "solvers" submodule - solvers.attr("__path__") = "ostk.astrodynamics.solvers"; - // Add objects to "solvers" submodule OpenSpaceToolkitAstrodynamicsPy_Solvers_TemporalConditionSolver(solvers); OpenSpaceToolkitAstrodynamicsPy_Solvers_FiniteDifferenceSolver(solvers); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/FiniteDifferenceSolver.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/FiniteDifferenceSolver.cpp index 1c5c593b1..23f33b9af 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/FiniteDifferenceSolver.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/FiniteDifferenceSolver.cpp @@ -24,8 +24,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Solvers_FiniteDifferenceSolver(pybin R"doc( A Finite Difference Solver to compute the gradient, and jacobian of a function. - Group: - solvers )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/TemporalConditionSolver.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/TemporalConditionSolver.cpp index 905460288..472ce1018 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/TemporalConditionSolver.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Solvers/TemporalConditionSolver.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Solvers_TemporalConditionSolver(pybi R"doc( Given a set of conditions and a time interval, the solver computes all sub-intervals over which conditions are met. - Group: - solvers )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp index f6ecbb818..46ed7abbf 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory.cpp @@ -28,8 +28,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule R"doc( Path followed by an object through space as a function of time. - Group: - trajectory )doc" ) @@ -139,9 +137,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory(pybind11::module& aModule // Create "trajectory" python submodule auto trajectory = aModule.def_submodule("trajectory"); - // Add __path__ attribute for "trajectory" submodule - trajectory.attr("__path__") = "ostk.astrodynamics.trajectory"; - // Add objects to python submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameTransformProvider(trajectory); OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameFactory(trajectory); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameDirection.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameDirection.cpp index 9e64c80f7..1c5733db9 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameDirection.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameDirection.cpp @@ -15,8 +15,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameDirectio R"doc( A local orbital frame direction. - Group: - trajectory )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameFactory.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameFactory.cpp index c70c1c78b..afba98d3e 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameFactory.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameFactory.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameFactory( R"doc( The local orbital frame factory. - Group: - trajectory )doc" ) .def( @@ -33,8 +31,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameFactory( Returns: Frame: True if the local orbital frame factory is defined, False otherwise. - Group: - trajectory )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameTransformProvider.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameTransformProvider.cpp index b2163d7a5..e6b0c00c3 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameTransformProvider.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/LocalOrbitalFrameTransformProvider.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_LocalOrbitalFrameTransfor Local orbital frame transform provider, frame provider. Generates a specific transform based on instant, position, velocity and a LOF type. - Group: - trajectory )doc" ); // TBI: can't make this linked with Shared diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp index 4e27b7ae0..a488c2f3f 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Model.cpp @@ -14,8 +14,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Model(pybind11::module &a R"doc( Orbital model. - Group: - trajectory )doc" ) .def( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp index 87397e5c3..204121c8f 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit.cpp @@ -36,8 +36,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a R"doc( Gravitationally curved trajectory of an object. - Group: - orbit )doc" ); @@ -383,9 +381,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit(pybind11::module& a // Create "orbit" python submodule auto orbit = aModule.def_submodule("orbit"); - // Add __path__ attribute for "orbit" submodule - orbit.attr("__path__") = "ostk.astrodynamics.trajectory.orbit"; - OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Model(orbit); OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models(orbit); OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Pass(orbit); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages.cpp index 21b06e0a2..97ee7b8fd 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages.cpp @@ -7,9 +7,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages(pybind11:: // Create "messages" python submodule auto messages = aModule.def_submodule("messages"); - // Add __path__ attribute for "messages" submodule - messages.attr("__path__") = "ostk.astrodynamics.trajectory.orbit.messages"; - // add objects to "messages" submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX(messages); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX.cpp index 90cda3b89..52c3c070f 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX.cpp @@ -7,9 +7,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX(pyb // Create "spacex" python submodule auto spacex = aModule.def_submodule("spacex"); - // Add __path__ attribute for "spacex" submodule - spacex.attr("__path__") = "ostk.astrodynamics.trajectory.orbit.messages.spacex"; - // add objects to "spacex" submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX_OPM(spacex); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX/OPM.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX/OPM.cpp index 7fff3aae7..2f3b2257e 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX/OPM.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Messages/SpaceX/OPM.cpp @@ -29,8 +29,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX_OPM See Also: `SpaceX OPM `_. - Group: - ccsds )doc" ); @@ -176,8 +174,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX_OPM R"doc( The header of the SpaceX OPM message. - Group: - spacex )doc" ) @@ -226,8 +222,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Messages_SpaceX_OPM R"doc( The deployment of the SpaceX OPM message. - Group: - spacex )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Model.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Model.cpp index 930446a1a..9a422a203 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Model.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Model.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Model(pybind11::mod Provides the interface for orbit models. - Group: - orbit )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models.cpp index ec1e6a03d..380b1fe2d 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models.cpp @@ -11,9 +11,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models(pybind11::mo // Create "models" python submodule auto models = aModule.def_submodule("models"); - // Add __path__ attribute for "models" submodule - models.attr("__path__") = "ostk.astrodynamics.trajectory.orbit.models"; - // add objects to "models" submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler(models); OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_SGP4(models); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler.cpp index 902b05b61..cca9c53b4 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler.cpp @@ -27,8 +27,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler(pybin Provides the interface for orbit models. - Group: - orbit )doc" ); @@ -258,8 +256,5 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler(pybin // Create "kepler" python submodule auto kepler = aModule.def_submodule("kepler"); - // Add __path__ attribute for "kepler" submodule - kepler.attr("__path__") = "ostk.astrodynamics.trajectory.orbit.models.kepler"; - OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler_COE(kepler); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMean.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMean.cpp index 006efa26d..b8916a70b 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMean.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMean.cpp @@ -54,8 +54,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLydda R"doc( Brouwer-Lyddane mean orbit elements. This is a parent class, please use the Short or Long child classes as appropriate. - Group: - orbital-elements )doc" ); @@ -74,8 +72,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLydda aop (Angle): The argument of periapsis. mean_anomaly (Angle): The mean anomaly. - Group: - Constructors )doc", arg("semi_major_axis"), arg("eccentricity"), @@ -157,9 +153,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLydda // Create "brouwerLyddaneMean" python submodule auto brouwerLyddaneMean = aModule.def_submodule("brouwerLyddaneMean"); - // Add __path__ attribute for "brouwerLyddaneMean" submodule - brouwerLyddaneMean.attr("__path__") = "ostk.astrodynamics.trajectory.orbit.models.brouwerLyddaneMean"; - OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLyddaneMean_BrouwerLyddaneMeanShort( brouwerLyddaneMean ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanLong.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanLong.cpp index 5b1ba3a86..6f32f73c2 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanLong.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanLong.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLydda R"doc( Brouwer-Lyddane Mean (Long) orbit elements. Short periodic variations and secular variations are averaged. - Group: - orbital-elements )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanShort.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanShort.cpp index 8a86112cb..0c3655c5f 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanShort.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/BrouwerLyddaneMeanShort.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_BrouwerLydda R"doc( Brouwer-Lyddane Mean (Short) orbit elements. Short periodic variations are averaged. - Group: - orbital-elements )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/COE.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/COE.cpp index 0801b5bcf..252966d8b 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/COE.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Kepler/COE.cpp @@ -36,8 +36,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler_COE(p r_a & = \text{apoapsis radius} \end{aligned} - Group: - orbital-elements )doc" ); @@ -91,8 +89,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Kepler_COE(p aop (Angle): The argument of periapsis. true_anomaly (Angle): The true anomaly. - Group: - Constructors )doc", arg("semi_major_axis"), arg("eccentricity"), diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Propagated.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Propagated.cpp index b3fb0f222..2a562fcfa 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Propagated.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Propagated.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Propagated(p Provides the interface for orbit models. - Group: - orbit )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4.cpp index 4a3c83006..142a7ccb0 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4.cpp @@ -20,8 +20,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_SGP4(pybind1 Provides the interface for orbit models. - Group: - orbit )doc" ) @@ -123,9 +121,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_SGP4(pybind1 // Create "sgp4" python submodule auto sgp4 = aModule.def_submodule("sgp4"); - // Add __path__ attribute for "sgp4" submodule - sgp4.attr("__path__") = "ostk.astrodynamics.sgp4"; - // Add objects to "sgp4" python submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_SGP4_TLE(sgp4); } diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4/TLE.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4/TLE.cpp index d18982152..a6e6a4803 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4/TLE.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/SGP4/TLE.cpp @@ -27,8 +27,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_SGP4_TLE(pyb Reference: https://en.wikipedia.org/wiki/Two-line_element_set - Group: - orbit )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Tabulated.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Tabulated.cpp index 2e73f02c1..8bc52e1cf 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Tabulated.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Models/Tabulated.cpp @@ -18,8 +18,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Models_Tabulated(py R"doc( Tabulated orbit model. - Group: - orbit )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Pass.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Pass.cpp index 40bb1788b..d250d8870 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Pass.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Orbit/Pass.cpp @@ -18,8 +18,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Orbit_Pass(pybind11::modu R"doc( A revolution of an orbiting object. - Group: - Orbit )doc" ); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp index 54375496c..50ee452d7 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Propagator.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Propagator(pybind11::modu R"doc( A `Propagator` that proapgates the provided `State` using it's `NumericalSolver` under the set `Dynamics`. - Group: - trajectory )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Segment.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Segment.cpp index fe4d14890..39fa3e293 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Segment.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Segment.cpp @@ -23,8 +23,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Segment(pybind11::module& R"doc( A `Segment` that can be solved provided an initial `State` and termination `Event Condition`. - Group: - trajectory )doc" ); @@ -34,8 +32,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Segment(pybind11::module& R"doc( The Solution object returned when a `Segment` is solved. - Group: - trajectory )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Sequence.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Sequence.cpp index 33e8b7c4e..205abc517 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Sequence.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/Sequence.cpp @@ -25,8 +25,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Sequence(pybind11::module R"doc( A mission `Sequence`. Consists of a list of `Segment` objects and various configuration parameters. - Group: - trajectory )doc" ); @@ -36,8 +34,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_Sequence(pybind11::module R"doc( The Solution object that is returned when a `Sequence` is solved. - Group: - trajectory )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp index 0a2709d61..94ab54ea1 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State.cpp @@ -29,8 +29,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State(pybind11::module& a R"doc( This class represents the physical state of an object. - Group: - state )doc" ) @@ -275,9 +273,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State(pybind11::module& a // Create "state" python submodule auto state = aModule.def_submodule("state"); - // Add __path__ attribute for "state" submodule - state.attr("__path__") = "ostk.astrodynamics.trajectory.state"; - OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesBroker(state); OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubset(state); OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(state); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesBroker.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesBroker.cpp index ad16f0b6a..0ef5be54e 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesBroker.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesBroker.cpp @@ -19,8 +19,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesBroker(p R"doc( Class to manage the coordinates subsets of a state. - Group: - state )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubset.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubset.cpp index 92ec7f2cb..033e48fe4 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubset.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubset.cpp @@ -94,10 +94,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubset(p State coordinates subset. It contains information related to a particular group of coordinates. It does not contain the coordinate values. - - - Group: - State )doc" ) @@ -255,9 +251,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubset(p // Create "coordinates_subset" python submodule auto coordinates_subset = aModule.def_submodule("coordinates_subset"); - // Add __path__ attribute for "coordinates_subset" submodule - coordinates_subset.attr("__path__") = "ostk.astrodynamics.trajectory.state.coordinates_subset"; - // Add objects to "coordinates_subset" submodule OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_AngularVelocity(coordinates_subset); OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_AttitudeQuaternion(coordinates_subset); diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AngularVelocity.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AngularVelocity.cpp index 1e1001f86..68022fd90 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AngularVelocity.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AngularVelocity.cpp @@ -23,8 +23,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_ Defined with respect to a reference frame and a Attitude quaternion. - Group: - state )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AttitudeQuaternion.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AttitudeQuaternion.cpp index d65e271ee..dde972211 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AttitudeQuaternion.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/AttitudeQuaternion.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_ Defined with respect to a reference frame. - Group: - state )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianPosition.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianPosition.cpp index 445b31500..72d824e68 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianPosition.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianPosition.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_ Defined with respect to a reference frame. - Group: - state )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianVelocity.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianVelocity.cpp index 8be5f7755..25fc1a84a 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianVelocity.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/CoordinatesSubsets/CartesianVelocity.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_CoordinatesSubsets_ Defined with respect to a reference frame and a Cartesian position. - Group: - state )doc" ) diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp index b72e5004a..84f6f0dca 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/State/NumericalSolver.cpp @@ -30,8 +30,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb The numerical solver can be used to integrate the trajectory of a dynamical system to a given instant, or to a set of instants, or until an `Event Condition` is met. - Group: - state )doc" ); @@ -41,8 +39,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_State_NumericalSolver(pyb R"doc( The solution to an event condition. - Group: - state )doc" ) .def_readonly( diff --git a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/StateBuilder.cpp b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/StateBuilder.cpp index b6a38e22f..4d35356c3 100644 --- a/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/StateBuilder.cpp +++ b/bindings/python/src/OpenSpaceToolkitAstrodynamicsPy/Trajectory/StateBuilder.cpp @@ -22,8 +22,6 @@ inline void OpenSpaceToolkitAstrodynamicsPy_Trajectory_StateBuilder(pybind11::mo R"doc( This class makes it convenient to build a `State` object. - Group: - trajectory )doc" ) diff --git a/docker/development/Dockerfile b/docker/development/Dockerfile index da7639432..dd69b7522 100644 --- a/docker/development/Dockerfile +++ b/docker/development/Dockerfile @@ -10,10 +10,10 @@ LABEL maintainer="lucas@loftorbital.com" # Dependencies -## Zip, jq, & git-lfs +## Additional deps RUN apt-get update \ - && apt-get install -y unzip jq git-lfs \ + && apt-get install -y unzip jq git-lfs locales \ && rm -rf /var/lib/apt/lists/* ## {fmt} @@ -163,6 +163,11 @@ RUN git clone --branch main --single-branch --depth=1 https://github.com/open-sp ENV OSTK_PHYSICS_DATA_LOCAL_REPOSITORY="/var/cache/open-space-toolkit-data/data" +RUN locale-gen en_US.UTF-8 +ENV LANG="en_US.UTF-8" +ENV LANGUAGE="en_US:en" +ENV LC_ALL="en_US.UTF-8" + # Labels ARG VERSION diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 283b6ad37..886cb6a13 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -7,7 +7,6 @@ SET (DOXYFILE "${CMAKE_CURRENT_BINARY_DIR}/Doxyfile") FILE (GLOB MARKDOWN_DOC "${PROJECT_SOURCE_DIR}/docs/*.md") LIST (APPEND MARKDOWN_DOC "${PROJECT_SOURCE_DIR}/README.md") -LIST (APPEND MARKDOWN_DOC "${PROJECT_SOURCE_DIR}/CONTRIBUTING.md") CONFIGURE_FILE (${DOXYFILE_IN} ${DOXYFILE} @ONLY) diff --git a/docs/_templates/custom-class-template.rst b/docs/_templates/custom-class-template.rst new file mode 100644 index 000000000..d64b80d51 --- /dev/null +++ b/docs/_templates/custom-class-template.rst @@ -0,0 +1,34 @@ +{{ fullname | escape | underline}} + +.. currentmodule:: {{ module }} + +.. autoclass:: {{ objname }} + :members: + :show-inheritance: + :inherited-members: + :special-members: __call__, __add__, __mul__ + + {% block methods %} + {% if methods %} + .. rubric:: {{ _('Methods') }} + + .. autosummary:: + :nosignatures: + {% for item in methods %} + {%- if not item.startswith('_') %} + ~{{ name }}.{{ item }} + {%- endif -%} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block attributes %} + {% if attributes %} + .. rubric:: {{ _('Attributes') }} + + .. autosummary:: + {% for item in attributes %} + ~{{ name }}.{{ item }} + {%- endfor %} + {% endif %} + {% endblock %} \ No newline at end of file diff --git a/docs/_templates/custom-module-template.rst b/docs/_templates/custom-module-template.rst new file mode 100644 index 000000000..2409e89a5 --- /dev/null +++ b/docs/_templates/custom-module-template.rst @@ -0,0 +1,54 @@ +{{ fullname | escape | underline}} + +.. automodule:: {{ fullname }} + + {% block attributes %} + {% if attributes %} + .. rubric:: Module attributes + + .. autosummary:: + :toctree: + {% for item in attributes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block functions %} + {% if functions %} + .. rubric:: {{ _('Functions') }} + + .. autosummary:: + :toctree: + :nosignatures: + {% for item in functions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block classes %} + {% if classes %} + .. rubric:: {{ _('Classes') }} + + .. autosummary:: + :toctree: + :template: custom-class-template.rst + :nosignatures: + {% for item in classes %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} + + {% block exceptions %} + {% if exceptions %} + .. rubric:: {{ _('Exceptions') }} + + .. autosummary:: + :toctree: + {% for item in exceptions %} + {{ item }} + {%- endfor %} + {% endif %} + {% endblock %} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 000000000..1fab3ca65 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,187 @@ +# +# python_example documentation build configuration file, created by +# sphinx-quickstart on Fri Feb 26 00:29:33 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +from ostk.astrodynamics import OpenSpaceToolkitAstrodynamicsPy + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "7.2" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.autosummary", + "sphinx.ext.napoleon", + "sphinx_math_dollar", + "sphinx_design", + "breathe", + "myst_nb", +] + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +add_module_names = False + +# The master toctree document. +master_doc = "index" + +# General information about the project. +project = "Open Space Toolkit Astrodynamics" +copyright = "2024, Lucas Bremond" +author = "Lucas Bremond" + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = OpenSpaceToolkitAstrodynamicsPy.__version__ +# The full version, including alpha/beta/rc tags. +release = OpenSpaceToolkitAstrodynamicsPy.__version__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = "english" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".ipynb_checkpoints"] + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +python_maximum_signature_line_length = 88 + +# -- Autodoc configuration ------------------------------------------------ + +autosummary_generate = True # Turn on sphinx.ext.autosummary +# autodoc_typehints = "description" # Add type hints to __init__ params +autodoc_member_order = "bysource" # Order members by source order +html_show_sourcelink = ( + False # Remove 'view source code' from top of page (for html, not python) +) +autodoc_inherit_docstrings = True # If no docstring, inherit from base class +set_type_checking_flag = True # Enable 'expensive' imports for sphinx_autodoc_typehints +autoclass_content = "both" # Include both class docstring and __init__ + + +def skip_member(app, what, name, obj, skip, options): + if name in { + "OpenSpaceToolkitAstrodynamicsPy", + "OpenSpaceToolkitCorePy", + "OpenSpaceToolkitIOPy", + "OpenSpaceToolkitMathematicsPy", + "OpenSpaceToolkitPhysicsPy", + "URL", + "ip", + "test", + }: + return True + + +def setup(app): + app.connect("autodoc-skip-member", skip_member) + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "sphinx_material" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "base_url": "https://open-space-collective.github.io/open-space-toolkit-astrodynamics/html/index.html", + "repo_url": "https://github.com/open-space-collective/open-space-toolkit-astrodynamics", + "repo_name": "Open Space Toolkit Astrodynamics", + "html_minify": True, + "css_minify": True, + "nav_title": "Open Space Toolkit Astrodynamics", + "logo_icon": "🛰", + "color_primary": "indigo", + "color_accent": "blue", + "globaltoc_depth": 2, + "globaltoc_collapse": True, +} + +html_sidebars = {"**": ["globaltoc.html", "localtoc.html", "searchbox.html"]} + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = "Open Space Toolkit Astrodynamics" + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ["_static"] + +# Output file base name for HTML help builder. +htmlhelp_basename = "ostk_astrodynamics_doc" + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + master_doc, + "Open Space Toolkit Astrodynamics", + "Open Space Toolkit Astrodynamics Documentation", + [author], + 1, + ) +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "numpy": ("https://numpy.org/doc/stable/", None), +} + +# -- Breathe configuration ------------------------------------------------- +highlight_language = "c++" + +breathe_projects = {"C++ Sphinx Doxygen Breathe": "xml/"} +breathe_default_project = "C++ Sphinx Doxygen Breathe" +breathe_default_members = ("members", "undoc-members") + +# -- MyST NB configuration ------------------------------------------------- +nb_execution_cache_path = "notebooks" +nb_execution_timeout = 60 +myst_footnote_transition = False diff --git a/docs/cpp.rst b/docs/cpp.rst new file mode 100644 index 000000000..4d91e74e5 --- /dev/null +++ b/docs/cpp.rst @@ -0,0 +1,8 @@ +C++ API Documentation +===================== + +.. toctree:: + :glob: + :maxdepth: 1 + + cpp_rst/class/* \ No newline at end of file diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index 3f0ed570e..b74781656 100755 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -761,7 +761,7 @@ WARN_LOGFILE = INPUT = @PROJECT_SOURCE_DIR@/README.md \ @PROJECT_SOURCE_DIR@/CONTRIBUTING.md \ - @PROJECT_SOURCE_DIR@/Tutorial.md \ + @PROJECT_SOURCE_DIR@/docs/Tutorial.md \ @PROJECT_SOURCE_DIR@/include \ @PROJECT_SOURCE_DIR@/src \ @PROJECT_SOURCE_DIR@/docs @@ -905,7 +905,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = README.md +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -1026,7 +1026,7 @@ IGNORE_PREFIX = # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. -GENERATE_HTML = YES +GENERATE_HTML = NO # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1569,7 +1569,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of @@ -1817,7 +1817,7 @@ MAN_LINKS = NO # captures the structure of the code including all documentation. # The default value is: NO. -GENERATE_XML = NO +GENERATE_XML = YES # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/docs/index.html b/docs/index.html index 58c8a1b64..fb6158cfe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,12 +1,13 @@ - - - + + + - - Redirecting... - + + Redirecting... + - + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..ec00bcbad --- /dev/null +++ b/docs/index.md @@ -0,0 +1,13 @@ +```{include} ../README.md +:relative-docs: ./ +:relative-images: +``` + +```{toctree} +:maxdepth: 1 +:hidden: + +cpp +python +notebook +``` \ No newline at end of file diff --git a/docs/notebook.rst b/docs/notebook.rst new file mode 100644 index 000000000..56655b866 --- /dev/null +++ b/docs/notebook.rst @@ -0,0 +1,8 @@ +Tutorial Notebooks +================== + +.. toctree:: + :glob: + :maxdepth: 1 + + _notebooks/* \ No newline at end of file diff --git a/docs/python.rst b/docs/python.rst new file mode 100644 index 000000000..8a5684902 --- /dev/null +++ b/docs/python.rst @@ -0,0 +1,28 @@ +Python API Documentation +======================== + +.. autosummary:: + :toctree: _autosummary + :template: custom-module-template.rst + :recursive: + + ostk.astrodynamics + ostk.astrodynamics.access + ostk.astrodynamics.conjunction.messages.ccsds + ostk.astrodynamics.dynamics + ostk.astrodynamics.event_condition + ostk.astrodynamics.flight + ostk.astrodynamics.flight.profile + ostk.astrodynamics.flight.profile.models + ostk.astrodynamics.flight.system + ostk.astrodynamics.guidance_law + ostk.astrodynamics.solvers + ostk.astrodynamics.trajectory + ostk.astrodynamics.trajectory.orbit + ostk.astrodynamics.trajectory.orbit.messages + ostk.astrodynamics.trajectory.orbit.messages.spacex + ostk.astrodynamics.trajectory.orbit.models + ostk.astrodynamics.trajectory.orbit.models.kepler + ostk.astrodynamics.trajectory.orbit.models.sgp4 + ostk.astrodynamics.trajectory.state + ostk.astrodynamics.trajectory.state.coordinates_subset \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..c591f4d47 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,10 @@ +# Apache License 2.0 + +sphinx~=7.2 +breathe~=4.35 +myst-parser~=2.0 +sphinx-math-dollar~=1.2 +sphinx-design~=0.5 +sphinx-material~=0.0 +kaleido~=0.2 +myst-nb~=1.0 \ No newline at end of file diff --git a/tutorials/cpp/sensor-modeling/README.md b/tutorials/cpp/sensor-modeling/README.md index 7fc247046..41cf26aff 100644 --- a/tutorials/cpp/sensor-modeling/README.md +++ b/tutorials/cpp/sensor-modeling/README.md @@ -1,5 +1,5 @@ Open Space Toolkit ▸ Astrodynamics ▸ Tutorials ▸ C++ ▸ Sensor Modeling -=========================================================== +====================================================================== ```bash cmake ..