ecocost 0.1.0__tar.gz

ecocost-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

ecocost-0.1.0/NOTICE

@@ -0,0 +1,88 @@
+ecocost
+Copyright 2026 Gooey.AI
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+The knowledge base in ecocost/data/ contains figures taken or derived from the
+third-party sources below. Their licences apply to those figures; the Apache
+License covers only this project's own code and compilation. Every value names
+its source in the YAML, and ecocost/data/sources.yaml records each source's
+licence and terms.
+
+
+Grid carbon intensity and generation mix (regions.yaml, countries)
+------------------------------------------------------------------
+Ember, Yearly Electricity Data, 2025.
+  https://ember-energy.org/data/yearly-electricity-data/
+  Licence: CC BY 4.0, https://creativecommons.org/licenses/by/4.0/
+Our World in Data, "Carbon intensity of electricity generation" and "Share of
+electricity production by source", based on Ember and the Energy Institute.
+  https://ourworldindata.org/grapher/carbon-intensity-electricity
+  https://ourworldindata.org/grapher/share-elec-by-source
+  Licence: CC BY 4.0
+Changes: values transcribed per country; intensity used as a lifecycle factor
+with a tier-based range added.
+
+
+Grid carbon intensity and generation mix (regions.yaml, US subregions)
+----------------------------------------------------------------------
+U.S. Environmental Protection Agency, eGRID2023 Summary Tables (rev. 2).
+  https://www.epa.gov/egrid
+  A work of the U.S. Government, not subject to copyright in the United States.
+Changes: direct emission rates multiplied by 1.124 (the 2023 Ember/eGRID
+national ratio) to put them on a lifecycle basis.
+
+
+Water consumed in electricity generation (regions.yaml)
+-------------------------------------------------------
+Reig, P., Luo, T., Christensen, E. and Sinistore, J. 2020. "Guidance for
+Calculating Water Use Embedded in Purchased Electricity." World Resources
+Institute. Appendices 1 and 2.
+  https://www.wri.org/research/guidance-calculating-water-use-embedded-purchased-electricity
+  Licence: the report is CC BY 4.0. Its appendix tables are based on data from
+  thinkstep AG (now Sphera), which the report makes available under separate,
+  more restrictive terms. ecocost uses a small number of aggregate national and
+  subregional factors (17 values) to support and explain its own calculated
+  results.
+Changes: converted from gal/kWh to L/kWh; ranges added.
+
+
+Primary energy factors (regions.yaml); closed-model size estimates (models.yaml)
+------------------------------------------------------------------------------
+EcoLogits, GenAI Impact. electricity_mixes.json and models.json.
+  https://github.com/genai-impact/ecologits
+  Licence: Mozilla Public License 2.0, https://mozilla.org/MPL/2.0/
+  Primary energy factors in electricity_mixes.json originate from ADEME Base
+  Empreinte, https://base-empreinte.ademe.fr/
+ecocost does not include EcoLogits source code or its data files; individual
+values were transcribed, and for primary energy divided by 3.6 (MJ/kWh to
+MJ/MJ).
+
+
+Measured inference energy (models.yaml, hardware.yaml)
+------------------------------------------------------
+The ML.ENERGY Leaderboard, University of Michigan.
+  https://ml.energy/leaderboard/
+  https://github.com/ml-energy/leaderboard
+Chung, J.-W. et al. "The ML.ENERGY Benchmark: Toward Automated Inference
+Energy Measurement and Optimization." 2025. https://arxiv.org/abs/2505.06371
+Changes: per-model Wh per 1k output tokens on H100, and paired H100/B200
+runs used to derive chip energy ratios.
+
+
+Hardware embodied carbon (hardware.yaml)
+----------------------------------------
+NVIDIA, HGX H100 Product Carbon Footprint Summary.
+ADEME / Lees-Perasso et al., GPU life-cycle assessment.
+Boavizta, BoaviztAPI server impact model, https://github.com/Boavizta/boaviztapi
+EcoLogits, LLM inference methodology, https://ecologits.ai/
+Figures cited, no code or data files included.
+
+
+Other factual figures
+---------------------
+Model parameter counts come from each model's published model card. Chip
+specifications come from vendor data sheets. PUE, WUE and site figures come
+from the operators' own sustainability reports and documentation. Epoch AI
+data is used under CC BY 4.0 (https://epoch.ai). Each value's source is linked
+in the YAML.

ecocost-0.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: ecocost
+Version: 0.1.0
+Summary: Per-run carbon, energy and water estimates for AI inference, with computed confidence and sourced inputs
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: carbon,energy,water,llm,inference,sustainability,sci
+Author: Gooey.AI
+Author-email: devs@dara.network
+Requires-Python: >=3.10
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software 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
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
+Project-URL: Bug Tracker, https://github.com/GooeyAI/ecocost/issues
+Project-URL: Documentation, https://github.com/GooeyAI/ecocost/blob/main/API.md
+Project-URL: Homepage, https://github.com/GooeyAI/ecocost
+Project-URL: Repository, https://github.com/GooeyAI/ecocost
+Description-Content-Type: text/markdown
+
+# ecocost
+
+```bash
+pip install ecocost
+```
+
+Per-request carbon, energy and water estimates for AI inference, each with a
+likely range and a confidence label computed from the evidence behind it.
+Every input is sourced and tiered, and the knowledge base in `ecocost/data/`
+is open to pull requests from providers, hardware makers and researchers.
+
+Maintained by [Gooey.AI](https://gooey.ai). Pure Python; the only dependency
+is PyYAML.
+
+## Quick start
+
+```python
+from ecocost import estimate
+
+r = estimate(
+    "gpt-oss-120b",
+    provider="nscale",
+    input_tokens=800,
+    output_tokens=300,
+)
+r["carbon"]      # {"unit": "gCO2e", "value": 0.0018, "min": ..., "max": ..., "worst_case": {...}}
+r["confidence"]  # {"level": "low", "ratio": 16.6, "reasons": ["wue_assumed", ...]}
+```
+
+Model ids are matched through aliases, so provider-specific ids such as
+`accounts/fireworks/models/gpt-oss-120b` resolve to the same record. A model
+that isn't in the knowledge base raises `UnknownModelError`, which suggests
+close matches and links to [adding it](CONTRIBUTING.md#adding-a-model). Ids
+are matched ignoring case.
+
+## Provider ids
+
+Who serves the request is taken, in order, from:
+
+1. `provider`: one of these ids. An unrecognised id raises
+   `UnknownProviderError`, so a typo can't silently estimate the wrong site.
+2. `base_url` (optional): the API endpoint you called. Its host is matched
+   against the hosts below; an unlisted host is ignored.
+3. For a closed model, its vendor's own API (`claude-*` → `anthropic`,
+   `gpt-*` → `openai`, …), flagged `provider_inferred_from_model`.
+4. Otherwise wide US defaults, flagged `provider_unknown_fallback`.
+
+| id | provider | API hosts |
+|---|---|---|
+| `fireworks` | Fireworks AI | `api.fireworks.ai` |
+| `nscale` | nScale | `inference.api.nscale.com` |
+| `openai` | OpenAI (direct API) | `api.openai.com` |
+| `anthropic` | Anthropic (direct API) | `api.anthropic.com` |
+| `google-vertex` | Google Vertex AI (us-central1) | `aiplatform.googleapis.com` |
+| `vercel-gateway` | Vercel AI Gateway | `ai-gateway.vercel.sh` |
+| `mistral` | Mistral AI (La Plateforme) | `api.mistral.ai` |
+| `alibaba-sg` | Alibaba Cloud Model Studio (Singapore) | `.ap-southeast-1.maas.aliyuncs.com` |
+| `modal` | Modal | `.modal.run` |
+| `zai` | Z.ai (Zhipu) | `api.z.ai` |
+| `sarvam` | Sarvam AI (Yotta NM1, Navi Mumbai) | `api.sarvam.ai` |
+| `fal` | fal.ai | — |
+| `novita` | Novita AI | `api.novita.ai` |
+| `meta` | Meta AI API | `api.meta.ai` |
+| `dhenu` | KissanAI Dhenu | `apibeta.dhenu.ai` |
+| `sea-lion` | AI Singapore SEA-LION API | `api.sea-lion.ai` |
+| `unknown-us` | Unknown provider (US default) | — |
+
+To add a provider, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## API
+
+One function:
+
+```python
+estimate(model, *, provider=None, base_url=None, input_tokens=0, output_tokens=0, cached_input_tokens=0, timestamp=None) -> EstimateResult
+```
+
+Full parameters, every output field, reason codes, errors and fallbacks, and versioning:
+**[API.md](API.md)**.
+
+### Output
+
+```
+model, provider, tokens
+carbon       gCO2e: value, min, max, worst_case {min, max}
+energy       Wh at the meter, primary_energy_mj
+water        mL: total, on_site (cooling, WUE), generation (off-site)
+confidence   level, ratio (max/min), reasons (every assumed input)
+electricity  region, country, gco2e_per_kwh (+ range), mix, dataset_year
+breakdown    h100_seconds, usage (operational) and embodied gCO2e
+assumptions  active params, chips, chip energy ratio, PUE, utilization, overhead, method_version
+provenance   trust, status, generated_by, stale for model, provider, region, hardware
+```
+
+`min`/`max` is the likely range; `worst_case` puts every input at its extreme
+at once. Cache results against `assumptions.method_version`.
+
+## How it works
+
+```
+tokens ─▶ FLOPs ─▶ H100-seconds ─▶ Wh at the meter ─▶ gCO2e operational + gCO2e embodied
+                                                    ─▶ mL water on-site + off-site
+```
+
+Location-based, lifecycle grid intensity, embodied carbon included, usage
+only. See [METHODOLOGY.md](METHODOLOGY.md) for the pipeline, the sources behind
+every default, how ranges and confidence are computed, calibration against
+published measurements, and the known gaps.
+
+## Confidence
+
+Every input carries an evidence tier: 1 published by the primary source, 2
+derived or proxy, 3 assumed. The confidence label is computed from the width of
+the likely carbon range (under 2x high, under 5x medium, otherwise low), never
+typed in. `reasons` lists each assumed input, so it doubles as the list of
+figures a provider could publish to tighten its estimates.
+
+## Data
+
+| File | What |
+|---|---|
+| `ecocost/data/models.yaml` | active and total parameters, measured energy, aliases |
+| `ecocost/data/providers.yaml` | serving regions and chips (with candidates), PUE, WUE, utilization, overhead |
+| `ecocost/data/regions.yaml` | grid intensity (lifecycle), mix, generation water, primary energy |
+| `ecocost/data/hardware.yaml` | TDP, peak FLOPS, energy ratio vs H100, embodied carbon |
+| `ecocost/data/sources.yaml` | every cited source, with its licence and terms of use |
+
+Every value has a `source`, a `tier` and an [OKF v0.2](https://github.com/GoogleCloudPlatform/open-knowledge-format/blob/main/SPEC.md)
+provenance block. To correct or add a figure, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Development
+
+```bash
+poetry install
+poetry run pytest -q
+```
+
+## License
+
+Code: Apache-2.0. The data draws on Ember and Our World in Data (CC BY 4.0),
+EPA eGRID, WRI, EcoLogits (MPL-2.0) and ML.ENERGY, among others; see
+[NOTICE](NOTICE) for attribution and each source's terms.
+

ecocost-0.1.0/README.md

@@ -0,0 +1,142 @@
+# ecocost
+
+```bash
+pip install ecocost
+```
+
+Per-request carbon, energy and water estimates for AI inference, each with a
+likely range and a confidence label computed from the evidence behind it.
+Every input is sourced and tiered, and the knowledge base in `ecocost/data/`
+is open to pull requests from providers, hardware makers and researchers.
+
+Maintained by [Gooey.AI](https://gooey.ai). Pure Python; the only dependency
+is PyYAML.
+
+## Quick start
+
+```python
+from ecocost import estimate
+
+r = estimate(
+    "gpt-oss-120b",
+    provider="nscale",
+    input_tokens=800,
+    output_tokens=300,
+)
+r["carbon"]      # {"unit": "gCO2e", "value": 0.0018, "min": ..., "max": ..., "worst_case": {...}}
+r["confidence"]  # {"level": "low", "ratio": 16.6, "reasons": ["wue_assumed", ...]}
+```
+
+Model ids are matched through aliases, so provider-specific ids such as
+`accounts/fireworks/models/gpt-oss-120b` resolve to the same record. A model
+that isn't in the knowledge base raises `UnknownModelError`, which suggests
+close matches and links to [adding it](CONTRIBUTING.md#adding-a-model). Ids
+are matched ignoring case.
+
+## Provider ids
+
+Who serves the request is taken, in order, from:
+
+1. `provider`: one of these ids. An unrecognised id raises
+   `UnknownProviderError`, so a typo can't silently estimate the wrong site.
+2. `base_url` (optional): the API endpoint you called. Its host is matched
+   against the hosts below; an unlisted host is ignored.
+3. For a closed model, its vendor's own API (`claude-*` → `anthropic`,
+   `gpt-*` → `openai`, …), flagged `provider_inferred_from_model`.
+4. Otherwise wide US defaults, flagged `provider_unknown_fallback`.
+
+| id | provider | API hosts |
+|---|---|---|
+| `fireworks` | Fireworks AI | `api.fireworks.ai` |
+| `nscale` | nScale | `inference.api.nscale.com` |
+| `openai` | OpenAI (direct API) | `api.openai.com` |
+| `anthropic` | Anthropic (direct API) | `api.anthropic.com` |
+| `google-vertex` | Google Vertex AI (us-central1) | `aiplatform.googleapis.com` |
+| `vercel-gateway` | Vercel AI Gateway | `ai-gateway.vercel.sh` |
+| `mistral` | Mistral AI (La Plateforme) | `api.mistral.ai` |
+| `alibaba-sg` | Alibaba Cloud Model Studio (Singapore) | `.ap-southeast-1.maas.aliyuncs.com` |
+| `modal` | Modal | `.modal.run` |
+| `zai` | Z.ai (Zhipu) | `api.z.ai` |
+| `sarvam` | Sarvam AI (Yotta NM1, Navi Mumbai) | `api.sarvam.ai` |
+| `fal` | fal.ai | — |
+| `novita` | Novita AI | `api.novita.ai` |
+| `meta` | Meta AI API | `api.meta.ai` |
+| `dhenu` | KissanAI Dhenu | `apibeta.dhenu.ai` |
+| `sea-lion` | AI Singapore SEA-LION API | `api.sea-lion.ai` |
+| `unknown-us` | Unknown provider (US default) | — |
+
+To add a provider, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## API
+
+One function:
+
+```python
+estimate(model, *, provider=None, base_url=None, input_tokens=0, output_tokens=0, cached_input_tokens=0, timestamp=None) -> EstimateResult
+```
+
+Full parameters, every output field, reason codes, errors and fallbacks, and versioning:
+**[API.md](API.md)**.
+
+### Output
+
+```
+model, provider, tokens
+carbon       gCO2e: value, min, max, worst_case {min, max}
+energy       Wh at the meter, primary_energy_mj
+water        mL: total, on_site (cooling, WUE), generation (off-site)
+confidence   level, ratio (max/min), reasons (every assumed input)
+electricity  region, country, gco2e_per_kwh (+ range), mix, dataset_year
+breakdown    h100_seconds, usage (operational) and embodied gCO2e
+assumptions  active params, chips, chip energy ratio, PUE, utilization, overhead, method_version
+provenance   trust, status, generated_by, stale for model, provider, region, hardware
+```
+
+`min`/`max` is the likely range; `worst_case` puts every input at its extreme
+at once. Cache results against `assumptions.method_version`.
+
+## How it works
+
+```
+tokens ─▶ FLOPs ─▶ H100-seconds ─▶ Wh at the meter ─▶ gCO2e operational + gCO2e embodied
+                                                    ─▶ mL water on-site + off-site
+```
+
+Location-based, lifecycle grid intensity, embodied carbon included, usage
+only. See [METHODOLOGY.md](METHODOLOGY.md) for the pipeline, the sources behind
+every default, how ranges and confidence are computed, calibration against
+published measurements, and the known gaps.
+
+## Confidence
+
+Every input carries an evidence tier: 1 published by the primary source, 2
+derived or proxy, 3 assumed. The confidence label is computed from the width of
+the likely carbon range (under 2x high, under 5x medium, otherwise low), never
+typed in. `reasons` lists each assumed input, so it doubles as the list of
+figures a provider could publish to tighten its estimates.
+
+## Data
+
+| File | What |
+|---|---|
+| `ecocost/data/models.yaml` | active and total parameters, measured energy, aliases |
+| `ecocost/data/providers.yaml` | serving regions and chips (with candidates), PUE, WUE, utilization, overhead |
+| `ecocost/data/regions.yaml` | grid intensity (lifecycle), mix, generation water, primary energy |
+| `ecocost/data/hardware.yaml` | TDP, peak FLOPS, energy ratio vs H100, embodied carbon |
+| `ecocost/data/sources.yaml` | every cited source, with its licence and terms of use |
+
+Every value has a `source`, a `tier` and an [OKF v0.2](https://github.com/GoogleCloudPlatform/open-knowledge-format/blob/main/SPEC.md)
+provenance block. To correct or add a figure, see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Development
+
+```bash
+poetry install
+poetry run pytest -q
+```
+
+## License
+
+Code: Apache-2.0. The data draws on Ember and Our World in Data (CC BY 4.0),
+EPA eGRID, WRI, EcoLogits (MPL-2.0) and ML.ENERGY, among others; see
+[NOTICE](NOTICE) for attribution and each source's terms.