Skip to content

Improve documentation related to pyCSEP #120

Description

@pabloitu

From the JOSS review by @keliankaz

One concern is that it may be difficult for those not very familiar with the pyCSEP ecosystem to get up an running with a floating experiment. This is unavoidable as floatCSEP is built around pyCSEP. Still, I wonder if providing a few more details in the tutorials to clearly explain aspects of the pyCSEP api that are being used would alleviate this issue. In most cases the required documentation is available in wither the "Defining an experiment" section or in the pyCSEP documentation.

The floatcsep documentation should provide a better overview of how each tutorial is interfacing with ```pycsep`` (e.g., which test function will the tutorial using, which forecast classes are involved, which catalog query functions or region readers we are using, etc.). Simultaneously, more clear links to the function/classes involved should be placed within each tutorial.

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

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions