Metadata-Version: 2.4
Name: electric-emission-cost
Version: 0.0.1
Summary: Calculate electricity-related emissions and costs.
Home-page: https://github.com/we3lab/electric-emission-cost
Author: WE3 Lab
Author-email: fchapin@stanford.edu
Keywords: electric-emission-cost
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: matplotlib>=3.8.4
Requires-Dist: requests>=2.31.0
Requires-Dist: cvxpy>=1.3.0
Requires-Dist: seaborn>=0.13.2
Requires-Dist: scipy>=1.2.1
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"
Provides-Extra: all
Requires-Dist: pandas>=2.2.1; extra == "all"
Requires-Dist: numpy>=1.26.4; extra == "all"
Requires-Dist: matplotlib>=3.8.4; extra == "all"
Requires-Dist: requests>=2.31.0; extra == "all"
Requires-Dist: cvxpy>=1.3.0; extra == "all"
Requires-Dist: seaborn>=0.13.2; extra == "all"
Requires-Dist: scipy>=1.2.1; 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"
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 Emission & Cost (EEC)
******************************

.. image::
   https://github.com/we3lab/electric-emission-cost/workflows/Build%20Main/badge.svg
   :height: 30
   :target: https://github.com/we3lab/electric-emission-cost/actions
   :alt: Build Status

.. image::
   https://github.com/we3lab/electric-emission-cost/workflows/Documentation/badge.svg
   :height: 30
   :target: https://we3lab.github.io/electric-emission-cost
   :alt: Documentation

.. image::
   https://codecov.io/gh/we3lab/electric-emission-cost/branch/main/graph/badge.svg
   :height: 30
   :target: https://codecov.io/gh/we3lab/electric-emission-cost
   :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 electric_emission_cost/tests --cov=electric_emission_cost --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 electric_emission_cost --count --verbose --show-source --statistics``

  This will lint the code and share all the style errors it finds.

5. ``black electric_emission_cost``

  This will reformat the code according to strict style guidelines.

Legal Documents
===============

This work was funded XX.

- `LICENSE <https://github.com/we3lab/electric-emission-cost/blob/main/LICENSE/>`_
- `CONTRIBUTING <https://github.com/we3lab/electric-emission-cost/blob/main/CONTRIBUTING.rst/>`_
