Skip to content

Open Sustainability Analyst

Guides for the analyst, plus an API reference generated from the Python docstrings.

Guides

  • Report analysis — upload a PDF, pick a question set, and run Chunk through Answer.
  • Parameters — chunk size, overlap, top K, model, and LLM scoring.
  • Question sets — the built-in frameworks and where their YAML lives.
  • Chunk highlighting — open an evidence chunk on its PDF page.
  • Benchmarking — score retrieval against an expert reference, including ClimRetrieve.

API reference

The core and enterprise page is the map. Each reference page is labeled Core (report_analyst/, Reciprocal Public License) or Enterprise (Climate+Tech Open License for Good). The class and function sections are generated with mkdocstrings. Adding a public symbol to one of those pages publishes its docstring on the next docs build.

Setup

Install and deploy guides live on the product site: