Proposal of tutorials

[ThibFrgsGmz]

I feel that the project lacks a tutorial to start using and mastering it.

Here are some ideas for tutorials. If you have better ones, feel free to suggest them!

• Introduction to Nyx: A basic tutorial introducing the project, its goals, features and target audience. This tutorial could include information on installing and configuring the development environment.

• Using Nyx with Rust: A tutorial showing how to integrate and use the Nyx library in a Rust project. It should include examples of how to use the various Nyx features, such as propagation, dynamic modeling, and orbit determination.

• Using Nyx with Python: A tutorial similar to the previous one, but focused on integrating and using the Nyx library in a Python project. It should also include examples of how to use the various Nyx features.

• Simulating a space mission with Nyx: a tutorial guiding the user through the creation and simulation of a space mission using Nyx features. This tutorial could cover aspects of mission design, propagation and analysis of results.

• Trajectory Optimization and Control with Nyx: a detailed tutorial on the use of optimal and suboptimal control algorithms to plan and optimize spacecraft trajectories using Nyx.

• Orbit Determination and Parameter Estimation with Nyx: A tutorial explaining how to use Nyx orbits and parameter estimation functions, such as Kalman filters and solar radiation pressure estimation.

• Celestial Calculations with Nyx: A tutorial showing how to perform various calculations related to celestial objects, such as eclipses, light time corrections and frame rotations using Nyx.

• Creating Custom Scenarios with Nyx: A tutorial explaining how to create and configure custom scenarios using the TOML file format and how to load them into Nyx for simulations.

[ChristopherRabotin]

Hi Thibault!

As soon as https://github.com/nyx-space/nyx/milestone/5 is completed and version 2.0.0-alpha is published, I can start working on some tutorials. These won't have much in terms of trajectory optimization, but they should cover almost everything that can be supported by orbit determination.

Trajectory optimization will need to be written after https://github.com/nyx-space/nyx/milestone/6 is completed.

Is there any format you think would be best for these tutorials ? Do you envision hosted Jupyter notebooks, a dedicated repository, a walk-through on https://nyxspace.com/, or something else entirely?

Thanks

[ThibFrgsGmz]

I admit that I am not sure. It seems to me that the implementation should be kept as simple as possible and not correlated to any particular tool/structure.

They should also be as easy to maintain as possible and maintained in CI. There is nothing more frustrating than finding tutorials that are not up-to-date, it leaves a very bad impression.

As an example of some random tutorials we have:

• https://github.com/pytorch/pytorch/blob/main/torch/csrc/lazy/tutorial.md
• https://github.com/facebook/hhvm/blob/master/third-party/wangle/src/tutorial.md
• https://github.com/charliermarsh/ruff/blob/main/docs/tutorial.md
• https://github.com/catchorg/Catch2/blob/devel/docs/tutorial.md
• https://gitlab.com/gitlab-org/gitlab-foss/blob/master/doc/ci/quick_start/tutorial.md

[gwbres]

maybe GNSS satellites state prediction using one SP3 file as input ?