search

OpenMDAO / dymos

Open Source Optimization of Dynamic Multidisciplinary Systems
Apache License 2.0
208 stars 66 forks source link

Add the phase instantiation signature to the dymos docs #446

Closed JustinSGray closed 2 years ago

JustinSGray commented 3 years ago

Summary of Issue

Docs show api methods, but not instantiation arguments

Issue Type

Description

This doc is missing the instantiation arguments. Users need to see that so they know how to set up kwargs for the ODE https://openmdao.github.io/dymos/api/phase_api.html

document these arguments: 

    Parameters
    ----------
    from_phase: Phase or None
        A phase instance from which the initialized phase should copy its data.
    transcription: TranscriptionBase
        The transcription to be utilized within the Phase.
    ode_class
        An OpenMDAO system class serving as the ODE for the phase.
    ode_init_kwargs: dict
        Keyword arguments used to initialize ode_class.
robfalck commented 2 years ago

Options are now listed on the phase api documentation.