Skip to content

Restructure examples directory #282

Closed
Closed
@BradyPlanden

Description

Feature description

The current examples directory includes a variety of unordered workflows. This should be restructured to provide a clearer entry point for users looking for specific functionality. I propose we do something like:

  • Optimisation Type (Fitting, Design Optim., etc.)
    • {model}_{cost function}.py

For both examples/notebooks/ and examples/scripts/. In this restructure we can reduce the total number of examples by using multipler optimisers for each {model}_{cost function}.py. This would look something like our integration test test_parameterisation.py.

Motivation

No response

Possible implementation

No response

Additional context

No response

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions