GSoC '25 project idea proposal

[santacodes]

This idea proposal is an extension of my work from last year on model entry points and the copier/cookiecutter template.

TL;DR

• Develop a standardized framework for integrating, distributing, and dynamically utilizing third-party battery models in PyBaMM.
• Extend the PyBaMM cookiecutter project to establish a structured model distribution template.
• Define guidelines for structuring models and documentation for seamless integration with PyBaMM.
• Implement model entry points and a dispatch API for dynamic model loading.
• Develop a PyBaMM CLI for effortless retrieval and installation of third-party models from PyBaMM model registries (serverless).

cc - @valentinsulzer @agriyakhetarpal @brosaplanella I would love to hear your thoughts and suggestions if you have anything to add or remove.

[netlify]

✅ Deploy Preview for pybamm-developer-preview ready!

Name	Link
🔨 Latest commit	3fd7c33
🔍 Latest deploy log	https://app.netlify.com/sites/pybamm-developer-preview/deploys/67d05f6e3faf3b00087a1e2e
😎 Deploy Preview	https://deploy-preview-258--pybamm-developer-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[agriyakhetarpal]

Thanks for the start, @santacodes! This is awesome. I left a few comments on the copy, and on what we can add to this memo to ensure we can have better-scoped proposals.

We can also leave in a few additional links, such as this old tutorial: https://docs.pybamm.org/en/v22.8/tutorials/add-model.html and the OxRSE course: https://train.rse.ox.ac.uk/material/HPCu/libraries/pybamm

[Saransh-cpp]

Thanks for adding this, @santacodes! See my comments below -

Edit: Aha, just saw @agriyakhetarpal's review. Please feel free to work on his comments before and then I can update my review.

[agriyakhetarpal]

Ah, @Saransh-cpp and I were reviewing at the same time :)

[santacodes]

Thank you for the suggestions, @Saransh-cpp @agriyakhetarpal. I batched and committed most of the suggestions that didn't have any comments, I will address the comments and add those changes. Meanwhile, feel free to review/suggest more if you have anything, especially in the context of this project, as it would be really helpful to give a good direction for the student whoever takes up this project.

[Saransh-cpp]

Nice, much cleaner now! Just a couple of more comments -

[Saransh-cpp]

Looks good now! Thanks, @santacodes! Some language fixes below -

[agriyakhetarpal]

Just a few comments, I'm happy to approve/merge after this. Thanks, @santacodes!

[agriyakhetarpal]

This looks great now, thanks for putting this together, @santacodes!

[arjxn-py]

Thanks @santacodes 🚀