Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Document the Estimator Object from the numerical_simulation module #31

Open
jo11he opened this issue Feb 3, 2022 · 2 comments
Open
Assignees

Comments

@jo11he
Copy link
Collaborator

jo11he commented Feb 3, 2022

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 jo11he self-assigned this Feb 3, 2022
@jo11he
Copy link
Collaborator Author

jo11he commented Feb 6, 2022

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
Copy link
Member

Great! I'll review it in the coming weeks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants