P.S. EIS is like a fancy tool to measure the battery's internal resistances and activities at different points, it acts like an AC tester of sorts that can give out information like how easily electrons are flowing through the materials the battery is made out of. Imagine gently pushing tiny electrical charges back and forth at various frequencies, which can help you find stuff like the resistance at the electrode surfaces (where the reactions are happening). @rtimms can probably correct me if I am wrong 😅
Though this project has been set up and hosted already, if we can verify from start to end that the template is able to generate all the files here and provide a reasonable starting point for constructing the files under https://github.com/pybamm-team/pybamm-eis/tree/main/pbeis, while also providing a way to integrate the docs under docs/ and with RTD, we can say that the template is ready to handle reasonably sized real-world research projects and we can then work on any shortcomings we find
@santacodes I think this repo could be a suitable candidate for you to try https://github.com/pybamm-team/pybamm-cookiecutter when we have the basic structure ready within a few weeks.
For context, this repo was originally proposed for adding the calculation of electrochemical impedance spectroscopy within the PyBaMM framework as a GSoC project (https://pybamm.org/gsoc/2022/#electrochemical-impedance-spectroscopy-eis-modelling), and later worked on as a summer project at the University of Oxford (see https://github.com/pybamm-team/pybamm-eis#-acknowledgments).
P.S. EIS is like a fancy tool to measure the battery's internal resistances and activities at different points, it acts like an AC tester of sorts that can give out information like how easily electrons are flowing through the materials the battery is made out of. Imagine gently pushing tiny electrical charges back and forth at various frequencies, which can help you find stuff like the resistance at the electrode surfaces (where the reactions are happening). @rtimms can probably correct me if I am wrong 😅
Though this project has been set up and hosted already, if we can verify from start to end that the template is able to generate all the files here and provide a reasonable starting point for constructing the files under https://github.com/pybamm-team/pybamm-eis/tree/main/pbeis, while also providing a way to integrate the docs under
docs/and with RTD, we can say that the template is ready to handle reasonably sized real-world research projects and we can then work on any shortcomings we find