Skip to content

Analysis documentation required (with examples) #3

Description

@pwolfram

Each analysis notebook should be configured to work with a dataset (in "example-datasets") to produce a desired analysis with output produced in terms of a saved figure(s). The running of the notebooks operating on example datasets should be specified in a python file in “example-scripts”. Resultant saved figures are be included in a CORE-level README.md (or perhaps grouped by analysis type for finer granularity) to provide a visual example of the analysis capability.

  • All analysis functions must have an appropriate docstring.
  • Provide visual examples of MPAS-Analysis capabilities in README.md

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

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions