Skip to content

Repo Organization #14

@StephMcCallum

Description

@StephMcCallum

Is your feature request related to a problem? Please describe.
If I'm looking to use a specific function, I'm unsure of which folder or example to find it in.

Describe the solution you'd like
I suggest that we organize the examples and folders to mirror the mupt repo. For example, if the notebook demonstrates the hierarchy of a mupt representation, it would go in mupt-examples/mupr-examples/. Or if the notebook shows how to import a molecule into mupt, then it goes in mupt-examples/interface-examples/.

Describe alternatives you've considered
For notebooks that contain full workflows, from import to build to export, we keep them in the high level repo. This suggestion is assuming that we will have many examples that cover one functionality.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions