Metadata-Version: 2.4
Name: marapendi
Version: 0.5.2
Summary: Framework for modelling anion and proton exchange membrane electrochemical cell devices, such as water electrolyzers and fuel cells. 
Author-email: Pedro Affonso Nobrega <pedro.affonso_nobrega@minesparis.psl.eu>
Maintainer-email: Pedro Affonso Nobrega <pedro.affonso_nobrega@minesparis.psl.eu>
License: The MIT License (MIT)
        =====================
        
        - Copyright © `2024` `Pedro Affonso Nobrega`
        
        Permission is hereby granted, free of charge, to any person
        obtaining a copy of this software and associated documentation
        files (the “Software”), to deal in the Software without
        restriction, including without limitation the rights to use,
        copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the
        Software is furnished to do so, subject to the following
        conditions:
        
        The above copyright notice and this permission notice shall be
        included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
        OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
        NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
        HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
        WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
        FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
        OTHER DEALINGS IN THE SOFTWARE.
        
Project-URL: Repository, https://git.persee.minesparis.psl.eu/matpro/marapendi
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <4.0.0,>=3.10
Description-Content-Type: text/markdown
License-File: LICENCE.md
License-File: AUTHORS.md
Requires-Dist: pandas
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: notebook
Requires-Dist: sphinx
Requires-Dist: scikit-learn
Dynamic: license-file

# marapendi

**marapendi** is a Python framework for physics-based modelling of proton-exchange
membrane (PEM) fuel cells.

**marapendi** offers:

- **A basis for building fuel cell and electrolyzer models** — pre-defined
  correlations and sub-models for heat transfer, reaction kinetics,
  two-phase transport, membrane water balance, ohmic losses, and more (see
  [Science](https://pages.persee.minesparis.psl.eu/matpro/marapendi/science/index.html)),
  with a focus on 0D PEM/AEM models. Sub-models are ordinary Python classes,
  so overriding a single correlation or swapping a whole sub-model is a
  matter of subclassing.
- **Fast, practical calibration, validation and simulation** — ready-to-use,
  fast steady-state and transient 0D cell models, low-cost enough to make
  sensitivity analysis, parameter estimation and cross-validation
  practical, through an easy-to-use API for defining, calibrating and
  simulating cell models in a few lines of code (see
  [Quick start](https://pages.persee.minesparis.psl.eu/matpro/marapendi/installation.html#quick-start)).
- **Open, readable and well-documented code** — multiple runnable examples
  demonstrating **marapendi**'s capabilities (see
  [Examples](https://pages.persee.minesparis.psl.eu/matpro/marapendi/auto_examples/index.html)),
  backed by detailed documentation and openly readable, commented code
  designed for transparency and easy understanding.
- **Cross-platform support** — a transient 0D model available as a
  MATLAB/Simulink S-function block (see
  [MATLAB / Simulink](https://pages.persee.minesparis.psl.eu/matpro/marapendi/user_guide/simulink_block.html)).
  Linking with the [VirtualFCS](https://github.com/Virtual-FCS/VirtualFCS)
  Modelica library is also planned for a future release.

## Repository
marapendi is developed on GitLab at
[git.persee.minesparis.psl.eu/matpro/marapendi](https://git.persee.minesparis.psl.eu/matpro/marapendi),
and mirrored to [github.com/affonsop/marapendi](https://github.com/affonsop/marapendi)
for external contributions (issues, pull requests). Releases are published to
[PyPI](https://pypi.org/project/marapendi/). 

## Documentation

The full documentation is available at:
[pages.persee.minesparis.psl.eu/matpro/marapendi](https://pages.persee.minesparis.psl.eu/matpro/marapendi).

## Author

Pedro Affonso Nobrega, pedro.affonso_nobrega@minesparis.psl.eu

## License

MIT License
