User Guide

This section provides in-depth documentation for every feature of OpenPyTEA. Follow the pages in order for a structured introduction, or jump directly to the topic you need.

Walkthrough notebook

The OpenPyTEA walkthrough notebook is a self-contained Jupyter notebook that covers the full workflow end-to-end — equipment costing, plant configuration, financial calculations, sensitivity analysis, and result export — with live code, outputs, and explanatory text. It is the recommended starting point before reading the individual guide pages.

Overview of the workflow

A typical OpenPyTEA study follows five steps:

1. Equipment costing  →  Equipment objects with purchased/direct costs
2. Plant configuration →  Costs, financial parameters, products, OPEX
3. Calculate           →  NPV, IRR, ROI, levelized cost, cash flows
4. Analyse             →  Sensitivity, tornado, Monte Carlo
5. Export              →  JSON results, publication-quality figures

Each step maps to a module:

Module

Key objects

Description

openpytea.equipment

Equipment

Equipment-level cost estimation with CEPCI inflation adjustment

openpytea.plant

Plant

Plant-level CAPEX, OPEX, and financial analysis

openpytea.analysis

Functions

Sensitivity, tornado, and Monte Carlo analysis

openpytea.plotting

Functions

Matplotlib-based publication-quality visualizations

openpytea.io

Functions

JSON configuration loading and result export