======= ASSETRA

.. image:: https://img.shields.io/pypi/v/assetra.svg :target: https://pypi.python.org/pypi/assetra

.. image:: https://readthedocs.org/projects/assetra/badge/?version=latest :target: https://assetra.readthedocs.io/en/latest/?version=latest :alt: Documentation Status

.. image:: https://github.com/ijbd/assetra/actions/workflows/tests.yml/badge.svg?branch=main :target: https://github.com/ijbd/assetra/actions/workflows/tests.yml :alt: Test status

.. image:: https://raw.githubusercontent.com/ijbd/assetra/main/.github/coverage.svg :target: https://github.com/ijbd/assetra/actions/workflows/tests.yml :alt: Test coverage

The ASSET Lab Resource adequacy package (assetra) is a light-weight, open-source energy system resource adequacy package maintained by the University of Michigan ASSET Lab.

• Free software: MIT license
• Documentation: https://assetra.readthedocs.io.

Features

• Probabilistic Monte Carlo state-sampling simulation framework, supporting: * Time-varying forced outage rates in thermal units * Sequential storage unit dispatch * User-defined energy unit types
• Resource adequacy calculation: * Expected unserved energy (EUE) * Loss of load hours (LOLH) * Loss of load days (LOLD) * Loss of load frequency (LOLF)
• Resource contribution calculation: * Effective load-carrying capability (ELCC)
• Object-oriented interface to manage energy units within energy systems
• Internal computation stored in xarray <https://docs.xarray.dev/en/stable/index.html>_ datasets

Platform & Python Version Compatibility

Due to required dependencies, assetra is currently available with the following versions of Python on the listed operating systems. As dependencies are updated we will continue to automatically update this matrix.

+------------------+-----------------+-----------------+-----------------+-----------------+-----------------+ | Operating System | Python 3.10 | Python 3.11 | Python 3.12 | Python 3.13 | Python 3.14 | +==================+=================+=================+=================+=================+=================+ | Ubuntu | |ubuntu_310| | |ubuntu_311| | |ubuntu_312| | |ubuntu_313| | |ubuntu_314| | +------------------+-----------------+-----------------+-----------------+-----------------+-----------------+ | Windows | |windows_310| | |windows_311| | |windows_312| | |windows_313| | |windows_314| | +------------------+-----------------+-----------------+-----------------+-----------------+-----------------+

.. |ubuntu_310| image:: https://img.shields.io/badge/Python_3.10-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |ubuntu_311| image:: https://img.shields.io/badge/Python_3.11-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |ubuntu_312| image:: https://img.shields.io/badge/Python_3.12-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |ubuntu_313| image:: https://img.shields.io/badge/Python_3.13-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |ubuntu_314| image:: https://img.shields.io/badge/Python_3.14-passing-brightgreen?style=flat-square&logo=python&logoColor=white

.. |windows_310| image:: https://img.shields.io/badge/Python_3.10-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |windows_311| image:: https://img.shields.io/badge/Python_3.11-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |windows_312| image:: https://img.shields.io/badge/Python_3.12-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |windows_313| image:: https://img.shields.io/badge/Python_3.13-passing-brightgreen?style=flat-square&logo=python&logoColor=white .. |windows_314| image:: https://img.shields.io/badge/Python_3.14-passing-brightgreen?style=flat-square&logo=python&logoColor=white

Credits

This package was created with Cookiecutter_ and the audreyr/cookiecutter-pypackage_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter .. _audreyr/cookiecutter-pypackage: https://github.com/audreyr/cookiecutter-pypackage