Skip to content

Notebook clean up #215

@ocefpaf

Description

@ocefpaf

I sent this package to a friend recently and they used the notebooks here as a starting point for a workshop. They sent me some feedback that is partially addressed in #214. Here is the rest of their feedback:

  • The notebooks should assume they are installed in an environment with all the packages and not try to install them. Users had many environments conflicts and/or unexpected changes when trying to run them. Suggestion: Provide an environment with binder, pixi, or just an env-file.
  • Notebook mixed Python syntax with sometimes 2 sometimes 4 spaces. That confused newcomers.
  • The notebooks have great value, but is lacking a narrative. They should be compiled as documentation in the project, adding their value to the docs, ensuring they are run with CIs, and putting them as the introduction to the package.

Pinging @7yl4r

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions