cideMOD

cideMOD copied to clipboard

.. |cideMOD_logo| image:: ./docs/source/Images/logo_final_cidemod_hor.png :alt: cideMOD_logo

.. |docs| image:: https://readthedocs.org/projects/cidemod/badge/?version=stable :alt: Documentation Status :scale: 100% :target: https://cidemod.readthedocs.io/en/stable/

.. |doi| image:: https://img.shields.io/badge/DOI-10.1149%2F1945--7111%2Fac91fb-informational :alt: Reference :scale: 100% :target: https://doi.org/10.1149/1945-7111/ac91fb

.. |release| image:: https://img.shields.io/github/v/release/cidetec-energy-storage/cideMOD?color=yellow :alt: Release :scale: 100% :target: https://github.com/cidetec-energy-storage/cideMOD/releases

.. |contributors| image:: https://img.shields.io/github/contributors/cidetec-energy-storage/cideMOD :alt: Contributors :scale: 100% :target: https://github.com/cidetec-energy-storage/cideMOD/graphs/contributors

.. |black_code| image:: https://img.shields.io/badge/code%20style-black-000000.svg :alt: Black :scale: 100% :target: https://github.com/ambv/black

.. |license| image:: https://img.shields.io/github/license/cidetec-energy-storage/cideMOD :alt: License :scale: 100% :target: https://github.com/cidetec-energy-storage/cideMOD/blob/main/LICENSE

.. |forks| image:: https://img.shields.io/github/forks/cidetec-energy-storage/cideMOD?style=social :alt: Forks :scale: 100% :target: https://github.com/cidetec-energy-storage/cideMOD/network/members

.. |twitter| image:: https://img.shields.io/twitter/follow/CIDETEC_?style=social :alt: Twitter :scale: 100% :target: https://twitter.com/CIDETEC_?ref_src=twsrc%5Egoogle%7Ctwcamp%5Eserp%7Ctwgr%5Eauthor

.. |docker| image:: https://img.shields.io/docker/v/cidetec/cidemod?label=Docker :alt: Docker image :scale: 100% :target: https://hub.docker.com/r/cidetec/cidemod

|cideMOD_logo|

|docs| |doi| |license| |docker|

|twitter|

CIDETEC's proprietary software cideMOD is based on the Doyle-Fuller-Newman model in which the physicochemical equations are solved by Finite Element methods using the FEniCSx library. It enables doing physics-based battery cell (herein after cell) simulations with a wide variety of use cases, from different drive cycles to studies of the SEI growth under storage conditions.

cideMOD is a pseudo X-dimensional (PXD) model that extends the original pseudo 2-dimensional (P2D) model, proposed by Newman and co-workers, from 1D to 2D and 3D cell geometries. Therefore, charge balance, mass balance and reaction kinetics, as well as energy balance, are spatially resolved for the entire cell geometry, considering the inhomogeneity of cell state properties. cideMOD has some additional models for solving the cell thermal behaviour, including mayor heat sources, and studying battery degradation mechanisms (e.g., SEI growth and loss of active material). It also supports several active materials in the electrodes, and, nonlinear and temperature dependent electrode and electrolyte transport properties.

It allows complete customization of the cell geometry including the tab position for optimal configuration, as well as highly customizable simulation conditions

Installation

The cideMOD model is based on the finite element platform FEniCSx and the library multiphenicsx. The current version of cideMOD runs on version 0.7.0 of dolfinx and the prefered installation method is using the conda-forge package for FEniCSx (https://github.com/conda-forge/fenics-dolfinx-feedstock). Thus, a new conda environment can be setup to install the corresponding versions of dolfinx and multiphenicsx

.. code-block:: console

$ conda create --name cidemod python=3.11 $ conda activate cidemod $ conda install fenics-dolfinx=0.7.0 fenics-libdolfinx=0.7.0 $ git clone -b dolfinx-v0.7.0 --depth 1 --single-branch https://github.com/multiphenics/multiphenicsx.git $ pip install ./multiphenicsx

To use cideMOD, first install it using pip:

.. code-block:: console

$ git clone https://github.com/cidetec-energy-storage/cideMOD.git $ pip install ./cideMOD

The P3D/P4D models make use of Gmsh meshes to create the battery mesh. Therefore, the python environment should be able to locate the Gmsh shared libraries. If your PYTHONPATH doesn't contains gmsh, you should add it:

.. code-block:: console

$ export PYTHONPATH=$PYTHONPATH:<path_to_gmsh_libs>

or

.. code-block:: console

$ export PYTHONPATH=$PYTHONPATH:$(find /usr/local/lib -name "gmsh-*-sdk")/lib

Additionally Gmsh needs from some libraries that you may not have installed:

.. code-block:: console

$ sudo apt-get update $ sudo apt-get install libglu1-mesa-dev libxcursor-dev libxinerama-dev libxft2 lib32ncurses6

To test if the installation is complete, run a simple test (within the tests folder):

.. code-block:: console

$ pytest -m "quicktest"

Read the Installation Section in the documentation for more information and installation options.

Documentation

The documentation can be viewed at ReadTheDocs <https://cidemod.readthedocs.io/en/stable/>_.

You can also access the documentation on the docs folder building it (See the requirements.txt file for necessary packages):

.. code-block:: console

$ cd docs/ $ make html

License

cideMOD is copyright (C) 2023 of CIDETEC Energy Storage and is distributed under the terms of the Affero GNU General Public License (GPL) version 3 or later.

Contact

For issues and bug reports visit:

https://github.com/cidetec-energy-storage/cideMOD

For other questions about cideMOD, you are welcome to contact us via email:

[email protected]