search

tudat-team / tudat-multidoc

BSD 2-Clause "Simplified" License
3 stars 8 forks source link

Document the Estimator Object from the numerical_simulation module #31

Open jo11he opened 2 years ago

jo11he commented 2 years ago

I noticed that I stopped my API documentation work at the level of the estimation_setup and estimation modules.

The Estimator object, being the highest-level and arguably most important part of any tudatpy estimation task, is located a level above, which is why it slipped my attention. I'll add that to the API docs asap.

jo11he commented 2 years ago

Done. While I was at it I also added the docs for the VariationalSolver. Since this is very high-level stuff, I think it is a good idea to review @DominicDirkx. https://tudatpy.readthedocs.io/en/latest/numerical_simulation.html#classes

DominicDirkx commented 2 years ago

Great! I'll review it in the coming weeks