Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Experimental classes in high-level package #124

Open
BradyPlanden opened this issue Nov 28, 2023 · 1 comment · May be fixed by #644
Open

Experimental classes in high-level package #124

BradyPlanden opened this issue Nov 28, 2023 · 1 comment · May be fixed by #644
Labels
enhancement New feature or request

Comments

@BradyPlanden
Copy link
Member

Feature description

After the discussion in the developers meeting, this issue is open to continue discussion for a higher-level API. I think this high level API would mimic PyBOP workflows, but could also provide other functionality. An example API for this package (pbx?) would be:

import pbx

pbx.load("path/to/data")
pbx.gitt(pbx.spm, parameter_set=params, etc.)
pbx.plot()

@martinjrobins @davidhowey @brosaplanella @NicolaCourtier

Motivation

This could provide a nice entry point for new-users; however, we would need more development resources to maintain both packages.

Possible implementation

No response

Additional context

No response

@BradyPlanden BradyPlanden added the enhancement New feature or request label Nov 28, 2023
@brosaplanella
Copy link
Contributor

Sorry for the delayed response, still clearing off backlog from before Christmas. I am not sure I see all the advantages of having a separate package. If pbx just contains the wrapper classes to streamline the process, it will be quite light but still require PyBOP as a dependency, so we will only be shaving a few lines of codes from PyBOP but we now have 2 packages to maintain and keep synced.

IMO, these wrapper classes could coexist with the more detailed workflows. It would be similar of how PyBaMM can be easily streamlined with a simulation of a standard model, but you can also use the methods in it to solve your own models.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants