Skip to content

Create a results object to encapsulate simulation results and logic #303

Description

@waltsims

Is your feature request related to a problem? Please describe.
kWaveFirstOrder returns a variety of values depending on the simulation configuration. The logic of which values are returned, how they should be displayed, and their meaning could be better managed. Currently, they are returned as a dictionary of values, which can be difficult for users to interpret.

Describe the solution you'd like
One possible solution is to use xarray.Datasets() to save the solution results and wrap all plotting and processing logic.

Describe alternatives you've considered
We've considered making custom classes internally.

Additional context
@djps came up with this suggestion

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions