8000 [COLLECTION]: Add code examples to API · Issue #238 · tudat-team/tudatpy · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
[COLLECTION]: Add code examples to API #238
Open
@larshinueber

Description

@larshinueber

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.interface:

  • spice
    • compute_rotation_matrix_between_frames

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
    • radiation_pressure.panelled_radiation_target e.g. for a simple Cubesat. Could also be substituted by a full example
  • 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0