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

[COLLECTION]: Add code examples to API #238

Open
16 tasks
larshinueber opened this issue Feb 14, 2025 · 0 comments
Open
16 tasks

[COLLECTION]: Add code examples to API #238

larshinueber opened this issue Feb 14, 2025 · 0 comments
Labels
documentation Suggests that documentation needs enriching

Comments

@larshinueber
Copy link
Contributor

larshinueber commented Feb 14, 2025

Hi all,

This issue is a collection of functions for which small code examples should be added to the docstrings.
Feel free to comment functions where you feel this is needed or edit this top-level comment directly.
If any function needs to be exposed to Python or missing docstrings entirely, add them to #211.

tudatpy.numerical_simulation:

  • environment
    • AtmosphereModel
  • environment_setup
    • gravity_field.ring_gravity
    • gravity_field.polyhedron_from_mu
    • gravity_field.polyhedron_from_density
    • rotation_model.constant_rotation_model Example is misleading
  • propagation_setup
    • step_size_control_blockwise_matrix_tolerance
    • simulator.propagation_results.single_arc_results
    • MultiArcPropagatorSettings.processing_settings
    • HybridArcPropagatorSettings.processing_settings
    • SingleArcPropagatorSettings.processing_settings
    • SingleArcPropagatorSettings.termination_settings
    • SingleArcPropagatorSettings.print_settings
    • propagator.custom_state
  • estimation
  • propagation
    • SingleArcSimulationResults.processed_state_ids
    • SingleArcSimulationResults.propagated_state_ids
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Suggests that documentation needs enriching
Projects
Status: Maintenance
Development

No branches or pull requests

1 participant