Metadata-Version: 2.4
Name: assetra
Version: 2026.8.12
Summary: ASSET Lab Resource Adequacy Package
License: MIT
License-File: LICENSE
Author: Isaac Bromley-Dulfano
Author-email: ijbd@umich.edu
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Requires-Dist: ipykernel (>=7.3.0,<8.0.0)
Requires-Dist: nbconvert (>=7.17.1,<8.0.0)
Requires-Dist: nbsphinx (>=0.9.0,<0.10.0)
Requires-Dist: nbsphinx-link (>=1.4.1,<2.0.0)
Requires-Dist: netCDF4 (>=1.7.2,<2.0.0)
Requires-Dist: xarray (>=2024.10.0,<2025.0.0)
Description-Content-Type: text/x-rst

=======
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
    :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 availible 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-failing-red?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-failing-red?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

