pyaesa Documentation

pyaesa is a Python package for absolute environmental sustainability assessment (AESA) workflows. It supports data download, data processing, deterministic calculations, figure rendering, Monte Carlo uncertainty and Sobol variance.

The documentation is organized for two audiences. The user documentation explains how to install the package, prepare data, select study objectives, run deterministic and uncertainty workflows, and cite data and methodological sources. The developer documentation is separate and is intended for Python developers modifying package internals.

Start with Package Overview for the package scope and installation. Use Workflow Reference for data sources, prerequisite functions, public function maps, and study objective routes. Use Tutorials for step-by-step examples and API Reference for the public function reference.

User Documentation

• Package Overview
  • Package Scope
  • Workflow Map
  • Example Output Figures
  • License
  • Community
  • Installation
• Workflow Reference
  • Data Sources By AESA Phase
  • Core Prerequisites
  • AESA Functions
  • Support Functions
  • Study Objectives And Routes
  • Set Of Tutorials
  • Methodological References
• Tutorials
  • Core Prerequisites
  • Study Objectives
  • Optional Workflows
  • Methodological References
• API Reference
  • Package Level Functions
• Methodological Notes
  • Recommended Citations
  • Functional Units And Allocation Methods
  • Allocated Carrying Capacities
  • Carrying Capacities

Developer Documentation

The pages below are for Python developers changing source code or adding allocation methods to the package.

• Developer Documentation
  • Contributor Guide
  • Package Architecture Notes
  • Developer Guide For Adding aSoCC Allocation Methods To The Package