eeco 0.1.0__tar.gz

eeco-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,47 @@
+************
+Contributing
+************
+
+Contribution Agreement
+======================
+This section describes the terms under which you may make “Contributions” — 
+which may include without limitation, software additions, revisions, bug fixes, configuration changes, documentation, or any other materials —
+to any of the projects owned or managed by the WE3Lab. 
+If you have questions about these terms, please contact Professor Mauter at mauter@stanford.edu.
+
+You certify that:
+
+- Your Contributions are either:
+
+  1. Created in whole or in part by you and you have the right to submit them under the designated license (described below); or
+  2. Based upon previous work that, to the best of your knowledge, 
+     is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, 
+     whether created in whole or in part by you, under the designated license; or
+  3.	Provided directly to you by some other person who certified (1) or (2) and you have not modified them.
+- You are granting your Contributions to the WE3Lab under the terms of the MIT license (the “designated license”).
+- You understand and agree that the WE3Lab projects and your Contributions are public and that a record of the Contributions 
+  (including all metadata and personal information you submit with them) is maintained indefinitely 
+  and may be redistributed consistent with the WE3Lab's mission and the MIT license.
+
+.. _CONTRIBUTING_Deploying:
+
+Deploying
+=========
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed.
+Then run:
+
+.. code-block:: bash
+
+  git checkout main
+  git pull
+  bumpversion [part]
+  git push
+  git branch -D stable
+  git checkout -b stable
+  git push --set-upstream origin stable -f
+  git push --tags
+
+Where ``[part]`` is ``major``, ``minor``, or ``patch``.
+This will release a new package version on Git + GitHub and publish to PyPI.

eeco-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 we3lab
+
+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.

eeco-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include CONTRIBUTING.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
+graft eeco/data

eeco-0.1.0/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: eeco
+Version: 0.1.0
+Summary: Calculate electricity-related emissions and costs.
+Home-page: https://github.com/we3lab/eeco
+Author: WE3Lab
+Author-email: fchapin@stanford.edu
+Keywords: eeco
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: Free for non-commercial use
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: pandas>=2.2.1
+Requires-Dist: numpy>=1.26.4
+Requires-Dist: cvxpy>=1.3.0
+Requires-Dist: pyomo>=6.7
+Requires-Dist: gurobipy>=11.0
+Requires-Dist: pint>=0.19.2
+Provides-Extra: setup
+Provides-Extra: test
+Requires-Dist: black>=22.3.0; extra == "test"
+Requires-Dist: flake8>=4.0.0; extra == "test"
+Requires-Dist: codecov>=2.1.4; extra == "test"
+Requires-Dist: pytest>=8.1.1; extra == "test"
+Requires-Dist: pytest-cov>=3.0.0; extra == "test"
+Requires-Dist: pytest-html>=3.1.1; extra == "test"
+Provides-Extra: dev
+Requires-Dist: black>=22.3.0; extra == "dev"
+Requires-Dist: flake8>=4.0.0; extra == "dev"
+Requires-Dist: codecov>=2.1.4; extra == "dev"
+Requires-Dist: pytest>=8.1.1; extra == "dev"
+Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
+Requires-Dist: pytest-html>=3.1.1; extra == "dev"
+Requires-Dist: Sphinx==7.0.1; extra == "dev"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "dev"
+Requires-Dist: tox>=3.24.5; extra == "dev"
+Requires-Dist: matplotlib>=3.8.4; extra == "dev"
+Requires-Dist: ipykernel; extra == "dev"
+Provides-Extra: all
+Requires-Dist: pandas>=2.2.1; extra == "all"
+Requires-Dist: numpy>=1.26.4; extra == "all"
+Requires-Dist: cvxpy>=1.3.0; extra == "all"
+Requires-Dist: pyomo>=6.7; extra == "all"
+Requires-Dist: gurobipy>=11.0; extra == "all"
+Requires-Dist: pint>=0.19.2; extra == "all"
+Requires-Dist: black>=22.3.0; extra == "all"
+Requires-Dist: flake8>=4.0.0; extra == "all"
+Requires-Dist: codecov>=2.1.4; extra == "all"
+Requires-Dist: pytest>=8.1.1; extra == "all"
+Requires-Dist: pytest-cov>=3.0.0; extra == "all"
+Requires-Dist: pytest-html>=3.1.1; extra == "all"
+Requires-Dist: Sphinx==7.0.1; extra == "all"
+Requires-Dist: sphinx-rtd-theme==2.0.0; extra == "all"
+Requires-Dist: tox>=3.24.5; extra == "all"
+Requires-Dist: matplotlib>=3.8.4; extra == "all"
+Requires-Dist: ipykernel; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+******************************************
+Electric Emissions & Cost Optimizer (EECO)
+******************************************
+
+.. image::
+   https://github.com/we3lab/eeco/workflows/Build%20Main/badge.svg
+   :height: 30
+   :target: https://github.com/we3lab/eeco/actions
+   :alt: Build Status
+
+.. image::
+   https://github.com/we3lab/eeco/workflows/Documentation/badge.svg
+   :height: 30
+   :target: https://we3lab.github.io/eeco
+   :alt: Documentation
+
+.. image::
+   https://codecov.io/gh/we3lab/eeco/branch/main/graph/badge.svg
+   :height: 30
+   :target: https://codecov.io/gh/we3lab/eeco
+   :alt: Code Coverage
+
+A package for calculating electricity-related emissions and costs for optimization problem formulation and other computational analyses.
+
+Useful Commands
+===============
+
+1. ``pip install -e .``
+
+  This will install your package in editable mode.
+
+2. ``pytest eeco/tests --cov=eeco --cov-report=html``
+
+  Produces an HTML test coverage report for the entire project which can
+  be found at ``htmlcov/index.html``.
+
+3. ``docs/make html``
+
+  This will generate an HTML version of the documentation which can be found
+  at ``_build/html/index.html``.
+
+4. ``flake8 eeco --count --verbose --show-source --statistics``
+
+  This will lint the code and share all the style errors it finds.
+
+5. ``black eeco``
+
+  This will reformat the code according to strict style guidelines.
+
+Documentation
+==============
+
+The documentation for this package is hosted on `GitHub Pages <https://we3lab.github.io/eeco>`_.
+
+Legal Documents
+===============
+
+This work was supported by the following grants and programs:
+
+- `National Alliance for Water Innovation (NAWI) <https://www.nawihub.org/>`_ (grant number UBJQH - MSM)
+- `Department of Energy, the Office of Energy Efficiency and Renewable Energy, Advanced Manufacturing Office <https://www.energy.gov/eere/ammto/advanced-materials-and-manufacturing-technologies-office>`_ (grant number DE-EE0009499)
+- `California Energy Commission (CEC) <https://www.energy.ca.gov/>`_ (grant number GFO-23-316)
+- `Equitable, Affordable & Resilient Nationwide Energy System Transition (EARNEST) Consortium <https://earnest.stanford.edu/>`_
+- `Stanford University Bits & Watts Initiative <https://bitsandwatts.stanford.edu/>`_
+- `Stanford Woods Institute Realizing Environmental Innovation Program (REIP) <https://woods.stanford.edu/research/funding-opportunities/realizing-environmental-innovation-program>`_
+- `Stanford Woods Institute Mentoring Undergraduate in Interdisciplinary Research (MUIR) Program <https://woods.stanford.edu/educating-leaders/education-leadership-programs/mentoring-undergraduates-interdisciplinary-research>`_
+- `Stanford University Sustainability Undergraduate Research in Geoscience and Engineering (SURGE) Program <https://sustainability.stanford.edu/our-community/access-belonging-community/surge>`_
+
+The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof. Neither the United States Government nor any agency thereof, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.
+
+- `LICENSE <https://github.com/we3lab/eeco/blob/main/LICENSE/>`_
+- `CONTRIBUTING <https://github.com/we3lab/eeco/blob/main/CONTRIBUTING.rst/>`_
+
+Attribution
+===========
+
+If you found this package useful, we encourage you to cite the following papers depending on which portion of the code you use:
+
+Citing `costs.py`
+*****************
+
+The development of `costs.py` was the culmination of two papers from the WE3Lab.
+
+The convex formulation of tariff costs for optimizing flexible loads was originally developed for a case study of flexible wastewater treatment plant operation published in Environmental Science & Technology:
+
+    Bolorinos, J., Mauter, M. S., & Rajagopal, R. Integrated energy flexibility management at wastewater treatment facilities. *Environ. Sci. Technol.* **57**, 18362-18371. (2023). DOI: `10.1021/acs.est.3c00365 <https://doi.org/10.1021/acs.est.3c00365>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+
+  @article{bolorinos2023integrated,
+    title={Integrated energy flexibility management at wastewater treatment facilities},
+    author={Bolorinos, Jose and Mauter, Meagan S and Rajagopal, Ram},
+    journal={Environmental Science \& Technology},
+    volume={57},
+    number={46},
+    pages={18362--18371},
+    year={2023},
+    publisher={ACS Publications},
+    url={https://doi.org/10.1021/acs.est.3c00365}
+  }
+
+
+The tariff data format was published in the following data descriptor in Nature Scientific Data:
+
+    Chapin, F.T., Bolorinos, J. & Mauter, M.S. Electricity and natural gas tariffs at United States wastewater treatment plants. *Sci Data* **11**, 113 (2024). DOI: `10.1038/s41597-023-02886-6 <https://doi.org/10.1038/s41597-023-02886-6>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @Article{Chapin2024,
+  author={Chapin, Fletcher T and Bolorinos, Jose and Mauter, Meagan S.},
+  title={Electricity and natural gas tariffs at United States wastewater treatment plants},
+  journal={Scientific Data},
+  year={2024},
+  month={Jan},
+  day={23},
+  volume={11},
+  number={1},
+  pages={113},
+  issn={2052-4463},
+  doi={10.1038/s41597-023-02886-6},
+  url={https://doi.org/10.1038/s41597-023-02886-6}
+  }
+
+Citing `emissions.py`
+*********************
+
+The emissions optimization code was originally developed for co-optimizing costs and emissions at a wastewater treatment plant and published in Environmental Science & Technology:
+
+    Chapin, F.T., Wettermark, D., Bolorinos, J. & Mauter, M.S. Load-shifting strategies for cost-effective emission reductions at wastewater facilities *Environ. Sci. Technol.* **59**, 2285-2294 (2025). DOI: `10.1021/acs.est.4c09773 <https://doi.org/10.1021/acs.est.4c09773>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @article{chapin2025load,
+    title={Load-Shifting Strategies for Cost-Effective Emission Reductions at Wastewater Facilities},
+    author={Chapin, Fletcher T and Wettermark, Daly and Bolorinos, Jose and Mauter, Meagan S},
+    journal={Environmental Science \& Technology},
+    volume={59},
+    number={4},
+    pages={2285--2294},
+    year={2025},
+    publisher={ACS Publications},
+    url={https://pubs.acs.org/doi/10.1021/acs.est.4c09773}
+  }
+
+Citing `metrics.py`
+*******************
+
+The flexibility metrics come from the following Nature Water paper:
+
+    Rao, A. K., Bolorinos, J., Musabandesu, E., Chapin, F. T., & Mauter, M. S. Valuing energy flexibility from water systems. *Nat. Water* **2**, 1028-1037 (2024). DOI: `10.1038/s44221-024-00316-4 <https://doi.org/10.1038/s44221-024-00316-4>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @article{rao2024valuing,
+    title={Valuing energy flexibility from water systems},
+    author={Rao, Akshay K and Bolorinos, Jose and Musabandesu, Erin and Chapin, Fletcher T and Mauter, Meagan S},
+    journal={Nature Water},
+    volume={2},
+    number={10},
+    pages={1028--1037},
+    year={2024},
+    publisher={Nature Publishing Group UK London},
+    url={https://doi.org/10.1038/s44221-024-00316-4}
+  }

eeco-0.1.0/README.rst

@@ -0,0 +1,172 @@
+******************************************
+Electric Emissions & Cost Optimizer (EECO)
+******************************************
+
+.. image::
+   https://github.com/we3lab/eeco/workflows/Build%20Main/badge.svg
+   :height: 30
+   :target: https://github.com/we3lab/eeco/actions
+   :alt: Build Status
+
+.. image::
+   https://github.com/we3lab/eeco/workflows/Documentation/badge.svg
+   :height: 30
+   :target: https://we3lab.github.io/eeco
+   :alt: Documentation
+
+.. image::
+   https://codecov.io/gh/we3lab/eeco/branch/main/graph/badge.svg
+   :height: 30
+   :target: https://codecov.io/gh/we3lab/eeco
+   :alt: Code Coverage
+
+A package for calculating electricity-related emissions and costs for optimization problem formulation and other computational analyses.
+
+Useful Commands
+===============
+
+1. ``pip install -e .``
+
+  This will install your package in editable mode.
+
+2. ``pytest eeco/tests --cov=eeco --cov-report=html``
+
+  Produces an HTML test coverage report for the entire project which can
+  be found at ``htmlcov/index.html``.
+
+3. ``docs/make html``
+
+  This will generate an HTML version of the documentation which can be found
+  at ``_build/html/index.html``.
+
+4. ``flake8 eeco --count --verbose --show-source --statistics``
+
+  This will lint the code and share all the style errors it finds.
+
+5. ``black eeco``
+
+  This will reformat the code according to strict style guidelines.
+
+Documentation
+==============
+
+The documentation for this package is hosted on `GitHub Pages <https://we3lab.github.io/eeco>`_.
+
+Legal Documents
+===============
+
+This work was supported by the following grants and programs:
+
+- `National Alliance for Water Innovation (NAWI) <https://www.nawihub.org/>`_ (grant number UBJQH - MSM)
+- `Department of Energy, the Office of Energy Efficiency and Renewable Energy, Advanced Manufacturing Office <https://www.energy.gov/eere/ammto/advanced-materials-and-manufacturing-technologies-office>`_ (grant number DE-EE0009499)
+- `California Energy Commission (CEC) <https://www.energy.ca.gov/>`_ (grant number GFO-23-316)
+- `Equitable, Affordable & Resilient Nationwide Energy System Transition (EARNEST) Consortium <https://earnest.stanford.edu/>`_
+- `Stanford University Bits & Watts Initiative <https://bitsandwatts.stanford.edu/>`_
+- `Stanford Woods Institute Realizing Environmental Innovation Program (REIP) <https://woods.stanford.edu/research/funding-opportunities/realizing-environmental-innovation-program>`_
+- `Stanford Woods Institute Mentoring Undergraduate in Interdisciplinary Research (MUIR) Program <https://woods.stanford.edu/educating-leaders/education-leadership-programs/mentoring-undergraduates-interdisciplinary-research>`_
+- `Stanford University Sustainability Undergraduate Research in Geoscience and Engineering (SURGE) Program <https://sustainability.stanford.edu/our-community/access-belonging-community/surge>`_
+
+The views and opinions of authors expressed herein do not necessarily state or reflect those of the United States Government or any agency thereof. Neither the United States Government nor any agency thereof, nor any of their employees, makes any warranty, express or implied, or assumes any legal liability or responsibility for the accuracy, completeness, or usefulness of any information, apparatus, product, or process disclosed, or represents that its use would not infringe privately owned rights.
+
+- `LICENSE <https://github.com/we3lab/eeco/blob/main/LICENSE/>`_
+- `CONTRIBUTING <https://github.com/we3lab/eeco/blob/main/CONTRIBUTING.rst/>`_
+
+Attribution
+===========
+
+If you found this package useful, we encourage you to cite the following papers depending on which portion of the code you use:
+
+Citing `costs.py`
+*****************
+
+The development of `costs.py` was the culmination of two papers from the WE3Lab.
+
+The convex formulation of tariff costs for optimizing flexible loads was originally developed for a case study of flexible wastewater treatment plant operation published in Environmental Science & Technology:
+
+    Bolorinos, J., Mauter, M. S., & Rajagopal, R. Integrated energy flexibility management at wastewater treatment facilities. *Environ. Sci. Technol.* **57**, 18362-18371. (2023). DOI: `10.1021/acs.est.3c00365 <https://doi.org/10.1021/acs.est.3c00365>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+
+  @article{bolorinos2023integrated,
+    title={Integrated energy flexibility management at wastewater treatment facilities},
+    author={Bolorinos, Jose and Mauter, Meagan S and Rajagopal, Ram},
+    journal={Environmental Science \& Technology},
+    volume={57},
+    number={46},
+    pages={18362--18371},
+    year={2023},
+    publisher={ACS Publications},
+    url={https://doi.org/10.1021/acs.est.3c00365}
+  }
+
+
+The tariff data format was published in the following data descriptor in Nature Scientific Data:
+
+    Chapin, F.T., Bolorinos, J. & Mauter, M.S. Electricity and natural gas tariffs at United States wastewater treatment plants. *Sci Data* **11**, 113 (2024). DOI: `10.1038/s41597-023-02886-6 <https://doi.org/10.1038/s41597-023-02886-6>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @Article{Chapin2024,
+  author={Chapin, Fletcher T and Bolorinos, Jose and Mauter, Meagan S.},
+  title={Electricity and natural gas tariffs at United States wastewater treatment plants},
+  journal={Scientific Data},
+  year={2024},
+  month={Jan},
+  day={23},
+  volume={11},
+  number={1},
+  pages={113},
+  issn={2052-4463},
+  doi={10.1038/s41597-023-02886-6},
+  url={https://doi.org/10.1038/s41597-023-02886-6}
+  }
+
+Citing `emissions.py`
+*********************
+
+The emissions optimization code was originally developed for co-optimizing costs and emissions at a wastewater treatment plant and published in Environmental Science & Technology:
+
+    Chapin, F.T., Wettermark, D., Bolorinos, J. & Mauter, M.S. Load-shifting strategies for cost-effective emission reductions at wastewater facilities *Environ. Sci. Technol.* **59**, 2285-2294 (2025). DOI: `10.1021/acs.est.4c09773 <https://doi.org/10.1021/acs.est.4c09773>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @article{chapin2025load,
+    title={Load-Shifting Strategies for Cost-Effective Emission Reductions at Wastewater Facilities},
+    author={Chapin, Fletcher T and Wettermark, Daly and Bolorinos, Jose and Mauter, Meagan S},
+    journal={Environmental Science \& Technology},
+    volume={59},
+    number={4},
+    pages={2285--2294},
+    year={2025},
+    publisher={ACS Publications},
+    url={https://pubs.acs.org/doi/10.1021/acs.est.4c09773}
+  }
+
+Citing `metrics.py`
+*******************
+
+The flexibility metrics come from the following Nature Water paper:
+
+    Rao, A. K., Bolorinos, J., Musabandesu, E., Chapin, F. T., & Mauter, M. S. Valuing energy flexibility from water systems. *Nat. Water* **2**, 1028-1037 (2024). DOI: `10.1038/s44221-024-00316-4 <https://doi.org/10.1038/s44221-024-00316-4>`_
+
+In `BibTeX` format:
+
+.. code-block:: 
+  
+  @article{rao2024valuing,
+    title={Valuing energy flexibility from water systems},
+    author={Rao, Akshay K and Bolorinos, Jose and Musabandesu, Erin and Chapin, Fletcher T and Mauter, Meagan S},
+    journal={Nature Water},
+    volume={2},
+    number={10},
+    pages={1028--1037},
+    year={2024},
+    publisher={Nature Publishing Group UK London},
+    url={https://doi.org/10.1038/s44221-024-00316-4}
+  }

eeco-0.1.0/docs/CONTRIBUTING.rst

@@ -0,0 +1,5 @@
+.. contents::
+
+.. _CONTRIBUTING:
+
+.. include:: ../CONTRIBUTING.rst

eeco-0.1.0/docs/LICENSE.rst

@@ -0,0 +1,8 @@
+.. contents::
+
+.. _LICENSE:
+
+MIT License
+===========
+
+.. include:: ../LICENSE

eeco-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python3 -msphinx
+SPHINXPROJ    = eeco
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

eeco-0.1.0/docs/complexities.rst

@@ -0,0 +1,78 @@
+.. contents::
+
+.. _complexities:
+
+******************************************
+What Makes Electricity Tariffs so Complex?
+******************************************
+
+To quote our paper, "Electricity and natural gas tariffs at United States wastewater treatment plants" [`Chapin 𝑁𝑎𝑡. 𝑆𝑐𝑖. 𝐷𝑎𝑡𝑎 (2024) <https://doi.org/10.1038/s41597-023-02886-6>`_]:
+
+    Tariffs typically have three components: 
+    (1) customer charges, or monthly minimum payments regardless of quantity of energy delivered, 
+    which vary by type of customer (e.g., residential, commercial); 
+    (2) energy charges billed by energy consumption in kWh or therms for electricity and natural gas, respectively; and 
+    (3) demand charges billed by monthly maximum electricity or natural gas usage in kW and therms/hr, respectively, and averaged over 5-15 minute increments. 
+    A therm is defined as 105.5 MJ, or the heat content of 100 cubic feet of methane at standard temperature and pressure.
+    More complex tariffs may also have tiered energy and demand charges based on cumulative monthly demand, seasonal (i.e., monthly) and 
+    time-of-use (i.e., daily and/or hourly) variation in marginal energy and demand charges, and bundled or decoupled generation and delivery charges.
+
+    Within each component of the tariff, there is tremendous variability across both the underlying tariff structure 
+    and the charge per unit of energy delivered. As alluded to above, 
+    some utilities establish tariffs with flat rate energy and demand charges, 
+    where the price of energy is constant throughout the day. 
+    Other utilities establish tariffs with a time-of-use (TOU) component, 
+    where a peak hour surcharge is applied to each kWh (or therm) of energy delivered and kW (or therm/hr) of demand. 
+    TOU periods can vary from weekend to weekday in addition to hour-to-hour. 
+    Prices may also change seasonally (i.e., month-to-month) based on climate, 
+    with the highest prices depending on whether heating or air conditioning drive the maximum load on the grid. 
+    Finally, prices often vary based on total monthly consumption. 
+    For example, Con Edison charges almost $33/therm for the first 3 therms delivered and less than $1/therm thereafter.
+
+Demand charges are particularly problematic for optimization problems since taking a maximum is not a matrix operation.
+Tiered charges provide another challenge since assumptions will have to be made about what tier a customer will fall into before the optimization problem is solved,
+but that assumption could be influenced by the results of the optimization problem (:ref:`why-consumption-est`).
+
+We standardized a machine-readable format for storing tariff data that addresses the complexities of tariff structure found across the United States (:ref:`data-format`).
+
+.. _categorize-tariffs:
+
+Categorizing Electricity Tariffs
+================================
+
+We also developed a categorization for the wide range of tariff structures present nationwide.
+To summarize their attributes, we descriptively categorized tariffs on two dimensions: 
+
+  1. the hourly, daily, and monthly variability of energy and demand charges (“temporality”), and
+  2. whether electric power generation and delivery charges are bundled (“bundling”).
+
+Temporality
+***********
+
+We categorize monthly electricity energy and demand charges into Flat, Seasonal-TOU, Nonseasonal-TOU, or Seasonal-NonTOU charges:
+  
+  - **Flat Charges**: Charges are constant throughout the year.
+  - **Seasonal-TOU Charges**: Charges vary monthly (Seasonal) and daily and/or hourly (TOU).
+  - **Nonseasonal-TOU Charges**: Charges are consistent from month to month, but vary daily and/or hourly.
+  - **Seasonal-NonTOU Charges**: Charges vary monthly, but are constant from day to day and hour to hour.
+
+.. figure:: _static/img/categorize-tariff.png
+    
+    Representative flat, time-of-use (TOU), and seasonal price profiles. 
+    (a) Winter prices and (b) summer prices representing Flat, Seasonal-TOU, Nonseasonal-TOU, and Seasonal-NonTOU tariffs. 
+    Cost would be calculated in $/kW, $/(therm/hr), $/kWh, or $/therm for electricity demand charges, natural gas demand charges, electricity energy charges, and natural gas energy charges, respectively. 
+    A therm is defined as 105.5 MJ, or approximately the heat content of 100 cubic feet of natural gas.
+
+Bundling
+********
+In the United States, generation, transmission, and distribution charges are commonly bundled into a single electricity energy charge. 
+However, in some cases, facilities pay separate generation (or supply) and delivery (or transmission and distribution) charges to a single provider or to generation and delivery providers separately. 
+For example, in much of the Texas interconnection, delivery and generation service providers are distinct.
+
+We developed a second categorization scheme for electricity tariffs based on the extent to which generation and delivery charges are bundled:
+
+  - Class 1: Fully bundled generation (supply) and delivery (transmission and distribution) charges.
+  - Class 2: Bundled generation and delivery charges with fuel cost adjustment based on the market price of fossil fuels.
+  - Class 3: Generation and delivery service from the same provider with pre-defined charges.
+  - Class 4: Generation and delivery service from the same provider with pre-defined delivery charges and variable generation charges that reflect real-time or day-ahead electricity prices set by the live market.
+  - Class 5: Generation and delivery service providers are legally required to be separate, and delivery charges are directly negotiated between customers and utilities. As a result, delivery charges are not published in tariff books, but can be obtained through public information requests.