NeqSim Reference Manual - Master Index

This document maps all 360+ documentation files to the reference manual structure. Use this as a comprehensive table of contents and navigation guide.

NeqSim Homepage: https://equinor.github.io/neqsimhome/

About NeqSim

NeqSim is an open-source library for calculation of fluid behavior, phase equilibrium, and process simulation. It is used for fluids such as oil and gas, carbon dioxide, refrigerants, hydrogen, ammonia, water, and chemicals.

NeqSim is distributed under the Apache-2.0 license and can be used via:

NeqSim Toolboxes

Toolbox Repository Description
NeqSim Java equinor/neqsim Core Java library
NeqSim Python equinor/neqsimpython Python bindings
NeqSim MATLAB equinor/neqsimmatlab MATLAB toolbox
NeqSim .NET equinor/neqsimNET .NET/C# integration
NeqSim Cape-Open equinor/neqsimcapeopen Cape-Open/Excel interface
NeqSim Native equinor/neqsim-native Native compilation via GraalVM

Web Applications & APIs

Application Link Description
NeqSim Web App neqsim.streamlit.app Browser-based calculations
NeqSim Colab NeqSim-Colab Jupyter/Colab notebook examples
NeqSimLive API NeqSimAPI Container-based APIs for digital twins
Process Models neqsimprocess Pre-built process model library

AI & Optimization

Project Repository Description
RL Agents NeqSim-Process-RL-Agents Multi-agent reinforcement learning for process optimization

Support & Community

Part I: Getting Started

Chapter 1: Introduction

Document Path Description
Overview docs/README.md Package overview and quick start
Modules docs/modules.md Architecture and module structure
O&G Design Review docs/NEQSIM_OIL_GAS_DESIGN_OPERATIONS_REVIEW.md Comprehensive capability review for oil & gas design and operations

Chapter 2: Quickstart Guides (NEW!)

Document Path Description
Quickstart Hub docs/quickstart/index.md Get running in 5 minutes - choose your platform
Java Quickstart docs/quickstart/java-quickstart.md Maven setup, first flash, first process
Python Quickstart docs/quickstart/python-quickstart.md pip install, jneqsim imports, gotchas
Colab Quickstart docs/quickstart/colab-quickstart.md One-click notebooks, no setup required

Chapter 3: Tutorials & Learning Paths (NEW!)

Document Path Description
Tutorials Hub docs/tutorials/index.md All tutorials organized by topic
Learning Paths docs/tutorials/learning-paths.md PVT Engineer, Process Engineer, Developer tracks
TEG Dehydration docs/tutorials/teg_dehydration_tutorial.md Complete TEG gas dehydration plant modeling
Solve Engineering Task docs/tutorials/solve-engineering-task.md Complete hands-on guide to the 3-step AI task-solving workflow
GOSP Tutorial docs/tutorials/gosp_tutorial.md Gas-oil separation plant (multi-stage separation)
PVT Lab Tests docs/pvtsimulation/pvt_lab_tests.md CCE, CVD, DL, separator test simulations

Chapter 4: Installation & Setup

Document Path Description
Getting Started docs/wiki/getting_started.md Installation and first steps
GitHub Setup docs/wiki/Getting-started-with-NeqSim-and-Github.md NeqSim and GitHub setup
Developer Setup docs/development/DEVELOPER_SETUP.md Development environment setup
Productization Roadmap docs/development/PRODUCTIZATION_ROADMAP.md Adoption, trust, contributor scaling plan
Benchmark Gallery docs/benchmarks/index.md Validation against NIST and published data

Chapter 5: Quick Start Examples

Document Path Description
Usage Examples docs/wiki/usage_examples.md Basic usage patterns
FAQ docs/wiki/faq.md Frequently asked questions
Wiki Index docs/wiki/index.md Wiki documentation index

Chapter 6: Cookbook & Troubleshooting (NEW!)

Document Path Description
Cookbook Index docs/cookbook/index.md Quick copy-paste recipes for common tasks
Thermodynamics Recipes docs/cookbook/thermodynamics-recipes.md Fluids, flash, properties, phase envelopes
Process Recipes docs/cookbook/process-recipes.md Separators, compressors, heat exchangers
Pipeline Recipes docs/cookbook/pipeline-recipes.md Pressure drop, multiphase flow
Unit Conversion docs/cookbook/unit-conversion-recipes.md All supported unit strings
Troubleshooting docs/troubleshooting/index.md Solutions to common problems

External Getting Started Guides

Platform Guide
Java Getting started in Java
Python Getting started in Python
MATLAB Getting started in MATLAB
Excel Getting started in Excel
Google Colab Demo notebook

Part II: Thermodynamics

Chapter 4: Fundamentals

Document Path Description
Thermo Overview docs/thermo/README.md Thermodynamics module overview
Thermodynamics Guide docs/wiki/thermodynamics_guide.md Comprehensive thermodynamics guide
System Types docs/thermo/system/README.md EoS system implementations

Chapter 5: Fluid Creation & Components

Document Path Description
Fluid Creation Guide docs/thermo/fluid_creation_guide.md Creating thermodynamic systems
Fluid Classification docs/thermo/fluid_classification.md Whitson methodology: FluidClassifier, ReservoirFluidType, GOR/C7+ classification
Component List docs/thermo/component_list.md Complete searchable list of all ~150+ components with CAS numbers and EoS availability
Component Database docs/thermo/component_database_guide.md Component properties and database
Component Package docs/thermo/component/README.md Component class documentation
Mathematical Models docs/thermo/mathematical_models.md Underlying mathematical models

Chapter 6: Equations of State

Document Path Description
Thermodynamic Models docs/thermo/thermodynamic_models.md Comprehensive guide to all thermodynamic models (EoS, CPA, GERG, electrolytes, GE models) with theory and usage
Søreide-Whitson Model docs/thermo/SoreideWhitsonModel.md Gas solubility in brine - Modified PR EoS with salinity effects, used in NeqSimLive for produced water emissions
GERG-2008 docs/thermo/gerg2008_eoscg.md GERG-2008, GERG-2008-H2, GERG-2008-NH3, and EOS-CG equations of state
GERG-2008-NH3 Notebook docs/examples/GERG2008_NH3_Ammonia_Properties.ipynb Ammonia properties with Gao EOS — density validation, mixture properties, isotherms
Mixing Rules docs/thermo/mixing_rules_guide.md Mixing rules and BIPs
Mixing Rule Package docs/thermo/mixingrule/README.md Mixing rule implementations
Phase Package docs/thermo/phase/README.md Phase modeling
Electrolyte CPA docs/thermo/ElectrolyteCPAModel.md Electrolyte CPA model

Chapter 7: Flash Calculations

Document Path Description
Flash Guide docs/thermo/flash_calculations_guide.md Flash calculation methods
Flash Equations docs/wiki/flash_equations_and_tests.md Flash equations and testing
Thermo Operations docs/thermo/thermodynamic_operations.md Thermodynamic operations
TP Flash Algorithm docs/thermodynamicoperations/TPflash_algorithm.md TP flash algorithm details
Reactive Flash docs/thermo/reactive_flash.md Simultaneous chemical and phase equilibrium (Modified RAND method)
Reactive PH Flash examples/notebooks/reactive_ph_flash_examples.ipynb Isenthalpic/isentropic reactive flash examples (PH, PS flash)
Reactive Distillation docs/process/reactive_distillation.md Reactive distillation column with equilibrium-based reactive flash on each tray
Phase Envelope Algorithm docs/thermodynamicoperations/phase_envelope_algorithm.md Michelsen continuation method, cricondenbar/cricondentherm Newton refinement, critical point detection
Thermo Ops Overview docs/thermodynamicoperations/README.md Thermodynamic operations module

Chapter 8: Fluid Characterization

Fluid characterization handles plus fraction splitting, property estimation, and lumping. New: A fluent API (configureLumping()) makes lumping configuration clearer - see the mathematics document for details.

Document Path Description
Characterization docs/wiki/fluid_characterization.md Fluid characterization guide with lumping API
TBP Fractions docs/wiki/tbp_fraction_models.md TBP fraction modeling
PVT Characterization docs/thermo/pvt_fluid_characterization.md PVT fluid characterization with lumping
Characterization Package docs/thermo/characterization/README.md Characterization module
Combining Methods docs/thermo/characterization/fluid_characterization_combining.md Fluid combining methods
Char Mathematics docs/pvtsimulation/fluid_characterization_mathematics.md Characterization mathematics with lumping equations

Chapter 9: Physical Properties

Document Path Description  
Reading Fluid Properties docs/thermo/reading_fluid_properties.md Comprehensive guide to calculating and reading properties from fluids, phases, and components  
Properties Overview docs/thermo/physical_properties.md Physical property calculations  
Physical Props Module docs/physical_properties/README.md Physical properties module  
H2S Distribution (Quick) docs/thermo/H2S_distribution_guide.md H2S phase distribution with Python examples - quick reference  
H2S Distribution (Detailed) docs/thermo/H2S_DISTRIBUTION_MODELING.md Comprehensive H2S modeling with Java examples and theory  
Viscosity Models docs/wiki/viscosity_models.md Viscosity calculation models  
Viscosity Detailed docs/physical_properties/viscosity_models.md Detailed viscosity models  
Density Models docs/physical_properties/density_models.md COSTALD (Hankinson-Thomson), Peneloux volume translation, Rackett — liquid density for mixtures, TBP fractions, aqueous/polar systems  
Thermal Conductivity docs/physical_properties/thermal_conductivity_models.md Thermal conductivity models  
Diffusivity docs/physical_properties/diffusivity_models.md Diffusivity models  
Interfacial Props docs/physical_properties/interfacial_properties.md Interfacial tension, etc.  
Scale Potential docs/physical_properties/scale_potential.md Scale potential calculations  
Adsorption Isotherm Models docs/thermo/adsorption_isotherms.md Langmuir, BET, Freundlich, Sips, DRA potential theory, capillary condensation  
Adsorption Review docs/physical_properties/adsorption_review.md Adsorption modeling review and enhancement proposal  
Steam Tables docs/wiki/steam_tables_if97.md IF97 steam table implementation  
Thermodynamic Workflows docs/thermo/thermodynamic_workflows.md Common thermodynamic workflows  
Interaction Tables docs/thermo/inter_table_guide.md Binary interaction parameters  

Chapter 10: Hydrates & Flow Assurance

Document Path Description
Flow Assurance Overview docs/pvtsimulation/flow_assurance_overview.md Integrated guide: hydrates, wax, asphaltenes, scale screening
Mineral Scale Formation docs/pvtsimulation/mineral_scale_formation.md Carbonate/sulfate scale, seawater mixing, SR calculations
Scale Prediction API docs/pvtsimulation/scale_prediction_api.md API reference: empirical vs EOS, solid solution, compatibility
pH Stabilization & Corrosion docs/pvtsimulation/ph_stabilization_corrosion.md Corrosion control, FeCO3 layer, Electrolyte CPA EoS
Hydrate Models docs/thermo/hydrate_models.md Hydrate equilibrium models
Hydrate Flash docs/thermodynamicoperations/hydrate_flash_operations.md Hydrate flash operations
Wax Characterization docs/thermo/characterization/wax_characterization.md Wax modeling, WAT calculation, flow assurance
Asphaltene Characterization docs/thermo/characterization/asphaltene_characterization.md SARA analysis, CII, CPA parameters

Part III: Process Simulation

Chapter 11: Process Fundamentals

Document Path Description
Process Overview docs/process/README.md Process simulation module
Process Guide docs/wiki/process_simulation.md Process simulation guide
Advanced Process docs/wiki/advanced_process_simulation.md Advanced techniques
Logical Operations docs/wiki/logical_unit_operations.md Logical unit operations
Process Design docs/process/process_design_guide.md Process design guide
Design Framework docs/process/DESIGN_FRAMEWORK.md Automated design & optimization framework
Optimization Roadmap docs/process/OPTIMIZATION_IMPROVEMENT_PROPOSAL.md Optimization implementation status
Pipeline Network Optimization docs/process/pipeline_network_optimization.md NLP optimizer, sparse solver, Pareto, benchmarks

Chapter 12: Process Systems & Models

Document Path Description
ProcessModel Overview docs/process/processmodel/README.md Process system management
ProcessSystem docs/process/processmodel/process_system.md ProcessSystem class (connections, stream introspection, named controllers, unified elements)
ProcessModel docs/process/processmodel/process_model.md Multi-process models
ProcessModule docs/process/processmodel/process_module.md Modular process units
Graph Simulation docs/process/processmodel/graph_simulation.md Graph-based simulation
Diagram Export docs/process/processmodel/diagram_export.md PFD diagram export
DEXPI Architecture docs/process/processmodel/DIAGRAM_ARCHITECTURE_DEXPI_SYNERGY.md DEXPI integration
Simulation Hooks docs/process/simulation-hooks-and-events.md Lifecycle hooks, ProcessEventBus, auto-validation for ProcessSystem and ProcessModel
UniSim/HYSYS Conversion docs/process/unisim-to-neqsim-conversion.md Convert UniSim Design (.usc) models to NeqSim and export NeqSim back to UniSim — COM automation, mapping tables, topology reconstruction, verification

Chapter 13: Streams & Mixers

Document Path Description
Streams docs/process/equipment/streams.md Stream models
Mixers/Splitters docs/process/equipment/mixers_splitters.md Mixer and splitter models
Equipment Overview docs/process/equipment/README.md Equipment module overview

Chapter 13b: Bio-Processing Unit Operations

Document Path Description
Bio-Processing Guide docs/process/bioprocessing.md Reactors, fermenters, enzyme treatment, solid-liquid separators, liquid-liquid extraction, multi-effect evaporators, dryers, crystallizers — mathematical models, design equations, simulation examples

Chapter 14: Separation Equipment

Document Path Description
Separators docs/process/equipment/separators.md Two/three-phase separators, scrubbers, entrainment specification (setEntrainment), design parameters, performance constraints (K-value, droplet cut size, retention time), Equinor TR3500 & API 12J compliance, entrainment performance in mechanical design JSON
Separator Entrainment Modeling docs/process/equipment/separator-entrainment-modeling.md Enhanced physics-based separator performance — droplet size distributions, flow regime prediction (Mandhane, Taitel-Dukler), inlet device modeling (7 types, Bothamley momentum), grade efficiency curves, Schiller-Naumann settling, expanded internals database (70+ internals, 31 inlet devices, 25 vendor curves), K-factor flooding, three-phase liquid-liquid separation, Csanady turbulence correction, API 12J compliance check, partial flooding model (Fabian/GPSA), auto liquid-liquid DSD (Hinze/ε inlet dissipation), EOS-derived oil-water volume fractions, vendor-certified efficiency curves (from factory acceptance tests), calibration framework (manual, auto, grouped, CSV batch fitting, JSON reports), mechanical design integration (entrainment fractions, efficiency, calibration factors in calcDesign()/toJson()), dynamic simulation integration (transient entrainment via runTransient(), VU flash → performance calculator → outlet composition, vessel inventory preserved, two-phase and three-phase separators)
Separator Entrainment Notebook examples/notebooks/separator_entrainment_modeling.ipynb Jupyter notebook: separator entrainment modeling — physics-based entrainment, droplet distributions, grade efficiency, internals selection, K-factor analysis, flow regime maps
Separator Vendor Curves & Calibration Notebook examples/notebooks/separator_vendor_curves_and_calibration.ipynb Jupyter notebook: vendor curves & calibration — expanded internals database (70+ records), 25 vendor-certified efficiency curves, vendor vs generic comparison, calibration framework (manual, auto, grouped, batch), JSON calibration reports, full database catalog export
Separator Dynamic Entrainment Notebook examples/notebooks/separator_dynamic_entrainment.ipynb Jupyter notebook: dynamic separator entrainment — transient simulation with enhanced entrainment, entrainment tracking over time, feed rate disturbance response, with/without entrainment comparison, three-phase separator dynamic, matplotlib visualizations
Distillation docs/process/equipment/distillation.md Distillation columns, ColumnSpecification (product purity, reflux ratio, component recovery, flow rate, duty), Builder pattern, solver options
Distillation Wiki docs/wiki/distillation_column.md Distillation column details
Absorbers docs/process/equipment/absorbers.md Absorption equipment: SimpleTEGAbsorber (Fs-factor sizing, dew point validation), SimpleAmineAbsorber (MDEA/DEA/MEA gas sweetening, design validation)
H2S Scavenger docs/process/H2S_scavenger_guide.md Chemical scavenging of H2S from gas - triazine, glyoxal, iron sponge, caustic, liquid redox
Membrane docs/wiki/membrane_separation.md Membrane separation
Membrane Equipment docs/process/equipment/membranes.md Membrane equipment
Filters docs/process/equipment/filters.md Filter equipment
Water Treatment docs/process/equipment/water_treatment.md Hydrocyclones (dP validation, efficiency estimation), GasFlotationUnit (IGF/DGF, per-stage efficiency, reject flow), produced water treatment trains, OIW limits

Chapter 15: Rotating Equipment

Document Path Description
Compressors docs/process/equipment/compressors.md Compressor models, drivers, speed-dependent power
Compressor Curves docs/process/equipment/compressor_curves.md Compressor performance curves
Compressor Design docs/process/CompressorMechanicalDesign.md Compressor mechanical design
Compressor Feasibility docs/process/compressor_design_feasibility.md Feasibility report: mechanical, cost, suppliers, curves
Pumps docs/process/equipment/pumps.md Pump models
Pump Guide docs/wiki/pump_usage_guide.md Pump usage guide
Pump Theory docs/wiki/pump_theory_and_implementation.md Pump theory
Expanders docs/process/equipment/expanders.md Expander models
Turboexpander docs/simulation/turboexpander_compressor_model.md Turboexpander model
Ejectors docs/process/equipment/ejectors.md Ejector systems

Chapter 16: Heat Transfer Equipment

Document Path Description
Heat Exchangers docs/process/equipment/heat_exchangers.md Heat exchanger models
Multi-Stream Heat Exchanger docs/process/equipment/multistream_heat_exchanger.md Comprehensive guide: composite curves, pinch analysis, LMTD, 1-3 unknown solvers for LNG/cryogenic applications
LNG Heat Exchanger (BAHX) docs/process/equipment/LNGHeatExchanger.md Brazed aluminium plate-fin: P1-P10 features, exergy, adaptive zones, Manglik-Bergles, transient, core sizing, freeze-out, maldistribution, mechanical design, cost
LNG Ageing Package docs/process/lng-ageing.md LNG weathering, stratification, rollover, BOG handling, methane number, sloshing, multi-tank ship models, ISO 6578
Air Cooler docs/wiki/air_cooler.md Air cooler models
Process Sim Enhancements docs/process/process-simulation-enhancements.md AirCooler thermal design, PackedColumn, column internals sizing, shortcut distillation, PVF flash, stream summary
Water Cooler docs/wiki/water_cooler.md Water cooler models
Steam Heater docs/wiki/steam_heater.md Steam heater models
Water Cooler & Reboiler docs/process/equipment/water_cooler_reboiler.md WaterCooler (IAPWS), ReBoiler for distillation
Mechanical Design docs/wiki/heat_exchanger_mechanical_design.md HX mechanical design
Thermal-Hydraulic Design docs/process/mechanical_design/thermal_hydraulic_design.md Shell-and-tube thermal design: Gnielinski, Kern, Bell-Delaware, LMTD correction, vibration screening, zone analysis
Two-Phase Heat Transfer docs/process/mechanical_design/two_phase_heat_transfer.md Shah condensation, Chen/Gungor-Winterton boiling, Friedel/MSH two-phase pressure drop, Ebert-Panchal fouling, incremental zone analysis, tube inserts
Heat Integration (Pinch Analysis) docs/process/equipment/heat_integration.md PinchAnalysis class: Linnhoff method, composite curves, grand composite curve, minimum utility targeting, HeatStream model

Chapter 17: Valves & Flow Control

Document Path Description
Valves docs/process/equipment/valves.md Valve models
Control Valves docs/process/equipment/control_valves.md CheckValve, LevelControlValve, PressureControlValve, ESD/PSD valves
Valve Design docs/process/ValveMechanicalDesign.md Valve mechanical design
Multiphase Choke Flow docs/process/MultiphaseChokeFlow.md Sachdeva, Gilbert two-phase choke models
Well Choke Implementation docs/process/well_choke_implementation.md Architecture, models, ThrottlingValve integration, Python usage
Flow Meters docs/wiki/flow_meter_models.md Flow metering
Venturi docs/wiki/venturi_calculation.md Venturi calculations
Tanks docs/process/equipment/tanks.md Tank models
Vessel Depressurization docs/process/equipment/vessel_depressurization.md Filling, blowdown, fire cases, transient wall HT, composite vessels, CNG/H2 tanks, flow assurance, real-gas beta, Biot correction, Rohsenow boiling, API reference
Measurement Devices docs/process/equipment/measurement_devices.md CO2 emissions, FIV analysis, NMVOC, dew points, safety detectors

Chapter 18: Special Equipment

Document Path Description
Reactors docs/process/equipment/reactors.md All reactor types overview (PFR, CSTR, Gibbs, stoichiometric, ammonia, sulfur, bio-processing)
Plug Flow Reactor Guide docs/process/equipment/plug_flow_reactor.md Kinetic PFR: power-law/LHHW/reversible kinetics, catalyst bed, Ergun ΔP, energy modes, axial profiles, Python
Gibbs Reactor docs/wiki/gibbs_reactor.md Gibbs reactor
Electrolyzers docs/process/equipment/electrolyzers.md Electrolyzer systems
CO2 Electrolyzer docs/pvtsimulation/CO2ElectrolyzerExample.md CO2 electrolyzer example
Flares docs/process/equipment/flares.md Flare systems
Adsorbers (SimpleAdsorber) docs/process/equipment/adsorbers.md Simplified gas absorption with MDEA
Adsorption Bed (Transient) docs/process/equipment/adsorption_bed.md Fixed-bed adsorption with LDF mass transfer, MTZ, PSA/TSA cycles
Mercury Removal Guard Bed docs/process/mercury_removal.md Chemisorption (PuraSpec), transient bed loading, breakthrough, degradation, mechanical design, cost estimation
Power Generation docs/process/equipment/power_generation.md GasTurbine, SteamTurbine, HRSG, CombinedCycleSystem, FuelCell, renewables (SolarPanel, WindTurbine, WindFarm)
Diff. Pressure docs/process/equipment/differential_pressure.md Orifice plates, flow measurement
Manifolds docs/process/equipment/manifolds.md Multi-stream routing
Battery Storage docs/process/equipment/battery_storage.md Energy storage systems, charge/discharge cycles, grid integration
Solar Panel docs/wiki/solar_panel.md Solar panel models
Failure Mode Modeling docs/process/equipment/failure_modes.md Equipment failure modes, reliability analysis, MTBF/MTTR calculations

Chapter 19: Wells, Pipelines & Subsea

Document Path Description
Wells docs/process/equipment/wells.md Well equipment
Well Simulation docs/simulation/well_simulation_guide.md Well simulation guide
Well & Choke docs/simulation/well_and_choke_simulation.md Choke valve simulation
Well Allocation docs/process/equipment/well_allocation.md Production allocation for commingled wells, VFM, well test methods
Pipelines docs/process/equipment/pipelines.md Pipeline and riser models
TwoFluidPipe Model docs/process/TWOFLUIDPIPE_MODEL.md Two-fluid multiphase flow model
TwoFluidPipe OLGA Comparison docs/wiki/two_fluid_model_olga_comparison.md Mathematical equations, slug flow physics, Lagrangian tracking
TwoFluidPipe Tutorial (Jupyter) docs/examples/TwoFluidPipe_Tutorial.ipynb Interactive notebook: multiphase flow, slug tracking, terrain effects, heat transfer
TwoFluidPipe Comprehensive Tutorial examples/notebooks/TwoFluidPipeMultiphaseFlowTutorial.ipynb Complete guide: steady-state, transient, three-phase (gas-oil-water), terrain effects, heat transfer, Beggs-Brill validation, slug tracking
Risers docs/process/equipment/pipelines.md#risers SCR, TTR, Flexible, Lazy-Wave risers
Beggs & Brill docs/process/PipeBeggsAndBrills.md Beggs & Brill correlation
CO2 Injection Well Analysis docs/process/co2_injection_well_analysis.md CO2InjectionWellAnalyzer, ImpurityMonitor, TransientWellbore, CO2FlowCorrections — integrated safety analysis for CO2 injection wells
Networks docs/process/equipment/networks.md Pipeline network modeling
Looped Pipeline Networks docs/process/equipment/looped_networks.md Hardy Cross solver, ring mains, parallel pipelines, loop detection
Production Well Networks docs/process/equipment/production_well_networks.md IPR (PI, Vogel, Fetkovich), chokes, tubing VLP, multiphase pipe, artificial lift, water handling, sand/solids, corrosion, emissions in NR-GGA solver
Production Network Tutorial examples/notebooks/production_well_network.ipynb 8-example notebook: IPR models, choke sensitivity, complete well system, multi-well gathering, choke allocation optimization
Advanced Network Features examples/notebooks/production_network_advanced_features.ipynb Artificial lift, 120-well scale, water handling, sand erosion (DNV RP O501), corrosion (NORSOK M-506), GHG emissions
Looped Network Solver docs/process/PIPELINE_NETWORK_SOLVER_ENHANCEMENT.md Hardy Cross looped network solver for ring mains and parallel pipelines
Looped Network Tutorial docs/examples/LoopedPipelineNetworkExample.ipynb Interactive notebook: ring mains, offshore rings, loop detection, Hardy Cross
Network Solver Tutorial docs/examples/NetworkSolverTutorial.md Tutorial for pipeline network solvers with worked examples
Pipe Fittings & Equivalent Length docs/process/PIPE_FITTINGS_EQUIVALENT_LENGTH.md Equivalent length method for fittings: elbows, tees, valves, reducers per CRANE TP-410
Reservoirs docs/process/equipment/reservoirs.md Reservoir modeling
Out-of-Zone Injection docs/process/out_of_zone_injection.md Multi-zone injection, fracture containment, annular leakage, MAASP (API RP 90), cement degradation, conformance monitoring
Out-of-Zone Injection Tutorial examples/notebooks/out_of_zone_injection.ipynb Interactive notebook: WellFlow injection mode, thermal stress, cement CO2 degradation, Hall plot
Subsea Systems docs/process/equipment/subsea_systems.md Subsea wells and flowlines
Subsea Equipment docs/process/equipment/subsea_equipment.md SubseaWell, SimpleFlowLine, flow assurance
Subsea Trees docs/process/equipment/subsea_trees.md Christmas trees: horizontal/vertical, dual-bore, valve configurations, wellhead integration
Subsea Manifolds docs/process/equipment/subsea_manifolds.md Production/injection manifolds, valve skids, well routing, gathering systems
Subsea Boosters docs/process/equipment/subsea_boosters.md Subsea pumps & compressors, helico-axial/multiphase, performance curves
Umbilicals docs/process/equipment/umbilicals.md Control umbilicals: hydraulic, electrical, chemical injection lines
SURF Subsea Equipment docs/process/SURF_SUBSEA_EQUIPMENT.md Comprehensive SURF equipment: PLET, PLEM, manifolds, trees, jumpers, umbilicals, flexible pipes, boosters with mechanical design and cost estimation
Well Mechanical Design docs/process/well_mechanical_design.md Standards-based well design: barrier elements/envelopes per NORSOK D-010, MAASP per API RP 90, CSV-driven design factors, cost estimation

Chapter 20: Utility Equipment

Document Path Description
Utility Overview docs/process/equipment/util/README.md Utility equipment
Adjusters docs/process/equipment/util/adjusters.md Adjuster units
Recycles docs/process/equipment/util/recycles.md Recycle units
Calculators docs/process/equipment/util/calculators.md Calculator units
Stream Saturator docs/process/equipment/util/saturators.md Water saturation utility for simulating reservoir conditions and wet gas systems
Stream Fitters docs/process/equipment/util/stream_fitters.md GORfitter, MPFMfitter: GOR/GVF adjustment, MPFM reference fluids
Fuel Gas System docs/process/equipment/util/fuel_gas_system.md Complete fuel gas conditioning: gas turbines, fired heaters, pilots, Wobbe Index, JT cooling
Utility Air System docs/process/equipment/util/utility_air_system.md ISO 8573-1 utility air: instrument/plant/breathing air, compressor/dryer sizing
Produced Water Degassing docs/process/equipment/util/produced_water_degassing.md Multi-stage degassing with GHG emissions per Norwegian regulations (Aktivitetsforskriften)

Chapter 21: Process Control

Document Path Description
Controllers docs/process/controllers.md Process controllers
Process Control docs/wiki/process_control.md Control systems
Dynamic Simulation Guide docs/simulation/dynamic_simulation_guide.md Comprehensive dynamic/transient simulation guide
Transient Simulation docs/wiki/process_transient_simulation_guide.md Transient simulation patterns

Chapter 22: Optimization and Constraints

January 2026 Update: ProductionOptimizer now includes configuration validation, stagnation detection, warm start, bounded LRU cache, and infeasibility diagnostics. See updated tutorials for details.

Document Path Description
Engineering Utilities Reference docs/util/engineering_utilities.md FluidBuilder, HMB, SensitivityAnalysis, MonteCarloSimulator, ConvergenceDiagnostics, HydrateRiskMapper, EOSComparison
Process Engineering Utilities v2 docs/process/engineering_utilities_v2.md PinchAnalyzer, DCFCalculator, DebottleneckAnalyzer, FiredHeater, ProcessValidator, CoolingWaterSystem
Optimization & Constraints Guide docs/process/optimization/OPTIMIZATION_AND_CONSTRAINTS.md COMPREHENSIVE: Complete guide to optimization algorithms, constraint types, bottleneck analysis, and practical examples
Optimization Overview docs/process/optimization/OPTIMIZATION_OVERVIEW.md START HERE: Introduction to process optimization, when to use ProcessOptimizationEngine vs ProductionOptimizer
ProductionOptimizer Tutorial docs/examples/ProductionOptimizer_Tutorial.md Interactive Jupyter notebook with complete ProductionOptimizer guide: algorithms, single/multi-variable, Pareto, constraints
Python Optimization Tutorial docs/examples/NeqSim_Python_Optimization.md Using SciPy/Python optimizers with NeqSim process simulations: constraints, Pareto, global optimization
Capacity Constraint Framework docs/process/CAPACITY_CONSTRAINT_FRAMEWORK.md Framework for equipment capacity limits, bottleneck detection, utilization tracking, and AIV/FIV vibration analysis
Optimizer Plugin Architecture docs/process/optimization/OPTIMIZER_PLUGIN_ARCHITECTURE.md Equipment capacity strategies, throughput optimization, gradient descent, sensitivity analysis, shadow prices, and Eclipse VFP export
External Optimizer Integration docs/integration/EXTERNAL_OPTIMIZER_INTEGRATION.md ProcessSimulationEvaluator for Python/SciPy/NLopt/Pyomo integration with gradient estimation
Web API / JSON Process Builder docs/integration/web_api_json_process_builder.md Build and run process simulations from JSON, structured error responses, equipment wiring API, multi-user session management
MCP Core Layer docs/integration/mcp_neqsim_core_layer.md MCP runners (FlashRunner, ProcessRunner, Validator, ComponentQuery), typed models, example/schema catalogs
MCP Getting Started docs/integration/mcp_getting_started.md 5-minute guide: connect any LLM to NeqSim via MCP — setup, first calculation, tool selection, common patterns
MCP Server Guide docs/integration/mcp_server_guide.md Quarkus MCP Server for VS Code Copilot, Claude Desktop, Cursor — installation, tools, resources, testing
Production Optimization Guide docs/examples/PRODUCTION_OPTIMIZATION_GUIDE.md Complete guide to production optimization with Java and Python examples
Pressure Boundary Optimization docs/process/pressure_boundary_optimization.md Calculate flow rates for pressure boundaries, generate Eclipse VFP lift curves, optimize compressor power
Flow Rate Optimization docs/process/optimization/flow-rate-optimization.md Comprehensive flow rate optimizer with lift curve generation for Eclipse reservoir simulation
Compressor Optimization Guide docs/process/optimization/COMPRESSOR_OPTIMIZATION_GUIDE.md Specialized guide for compressor train optimization, anti-surge control, and power minimization
Practical Examples docs/process/optimization/PRACTICAL_EXAMPLES.md Working examples for optimization scenarios including gas processing, LNG, and offshore platforms

Chapter 23: Mechanical Design

Document Path Description
Mechanical Design docs/process/mechanical_design.md Mechanical design overview, process design parameters, validation, and JSON export
Equipment Design Parameters docs/process/EQUIPMENT_DESIGN_PARAMETERS.md Comprehensive guide to autoSize vs MechanicalDesign, manual sizing, validation methods, and capacity constraints
Process Design Parameters docs/process/mechanical_design.md#process-design-parameters Industry-standard process design parameters for separators, compressors, pumps, heat exchangers
Design Validation docs/process/mechanical_design.md#design-validation Validation methods per API-610, API-617, TEMA, API-12J standards
Mechanical Design Report docs/process/mechanical_design.md#comprehensive-mechanical-design-report-json Combined JSON output for all mechanical design data (equipment + piping)
Compressor Casing Design docs/process/CompressorMechanicalDesign.md#casing-wall-thickness-asme-viii-div-1-ug-27 Compressor casing design per API 617 / ASME VIII: wall thickness, material selection, flange rating, nozzle loads, NACE MR0175, thermal growth, split-line bolts, barrel casing
Design Standards docs/process/mechanical_design_standards.md Design standards
Design Database docs/process/mechanical_design_database.md Design database
Pipeline Mechanical Design docs/process/pipeline_mechanical_design.md Comprehensive pipeline mechanical design with wall thickness, stress analysis, cost estimation
Topside Piping Design docs/process/topside_piping_design.md Topside piping design with velocity, support spacing, vibration (AIV/FIV), stress analysis per ASME B31.3
Manifold Mechanical Design docs/process/equipment/manifold_design.md Manifold design for topside, onshore, and subsea with velocity limits, reinforcement, support per ASME B31.3 and DNV-ST-F101
Riser Mechanical Design docs/process/riser_mechanical_design.md Riser design with catenary mechanics, VIV, fatigue per DNV-OS-F201
Pipeline Design Math docs/process/pipeline_mechanical_design_math.md Mathematical methods and formulas for pipeline design
Subsea SURF Mechanical Design docs/process/SURF_SUBSEA_EQUIPMENT.md#mechanical-design Mechanical design for PLET, PLEM, trees, manifolds, jumpers, umbilicals, flexible pipes, boosters per DNV, API, ISO, NORSOK
Well Mechanical Design docs/process/well_mechanical_design.md Standards-based well design: barrier elements/envelopes per NORSOK D-010, MAASP per API RP 90, CSV-driven design factors, cost estimation
Equipment Datasheet Generator docs/process/equipment_datasheets.md Structured JSON equipment datasheets from process simulation (separator, compressor, heater, valve)
Dual EoS Comparison docs/process/dual_eos_comparison.md SRK vs PR78 cross-check per TR1244 for field development QA
TORG Integration docs/process/torg_integration.md TORG integration
Field Development docs/process/field_development_orchestration.md Field development orchestration

Chapter 24: Electrical Design

Document Path Description
Electrical Design Guide docs/process/electrical-design.md Comprehensive guide to electrical design: motor sizing (IEC 60034), VFD topology, cable sizing, transformer, switchgear, hazardous area, load list, equipment-specific designs (separator, heater/cooler, pipeline), plant-wide SystemElectricalDesign
Motor Mechanical Design docs/process/motor-mechanical-design.md Motor physical/mechanical design: foundation loads (IEEE 841), cooling (IEC 60034-6), bearings (ISO 281), vibration (ISO 10816-3), noise (IEC 60034-9, NORSOK S-002), enclosure (IEC 60034-5, IEC 60079), derating (IEC 60034-1)
Combined Equipment Design Report docs/process/motor-mechanical-design.md#equipmentdesignreport EquipmentDesignReport: combined mechanical + electrical + motor design report with feasibility verdict for any equipment
Compressor Electrical Design examples/notebooks/electrical/compressor_electrical_design.ipynb Jupyter notebook: 2-stage compression electrical design with motor curves, power triangle, efficiency chain
Process Plant Load List examples/notebooks/electrical/process_plant_load_list.ipynb Jupyter notebook: plant-wide electrical load list, demand/diversity factors, transformer sizing
Motor & VFD Analysis examples/notebooks/electrical/motor_vfd_analysis.ipynb Jupyter notebook: motor efficiency classes IE1-IE4, VFD topology selection, harmonics, efficiency maps, cable sizing, hazardous area
Power-from-Shore Feasibility examples/notebooks/electrical/power_from_shore_feasibility.ipynb Jupyter notebook: submarine cable sizing, HVAC/HVDC, cost estimation, CO₂ comparison, regional analysis (Norway, UK, Brazil, GoM)

Chapter 25: Instrument Design

Document Path Description
Instrument Design Guide docs/process/instrument-design.md Comprehensive guide to instrument design: ISA-5.1 identification, SIL-rated safety instruments, I/O counting, DCS/SIS cabinet sizing, cost estimation, equipment-specific designs (separator, compressor, heat exchanger, pipeline, valve), plant-wide SystemInstrumentDesign

Chapter 26: Dynamic Simulation

Document Path Description
Dynamic Simulation Guide docs/process/dynamic-simulation.md DynamicProcessHelper utility — auto-instruments a sized steady-state process with transmitters and PID controllers for transient simulation, configurable PID tuning, flow and temperature control loops

Chapter 23b: Cost Estimation

Document Path Description
Cost Estimation Framework docs/process/COST_ESTIMATION_FRAMEWORK.md Comprehensive capital and operating cost estimation framework
Cost Estimation API docs/process/COST_ESTIMATION_API_REFERENCE.md Detailed API reference for all cost estimation classes
Subsea SURF Cost Estimation docs/process/SURF_SUBSEA_EQUIPMENT.md#cost-estimation Cost estimation for all SURF equipment with regional factors, labor rates, vessel costs, BOM generation
Equipment Costs docs/process/COST_ESTIMATION_FRAMEWORK.md#equipment-cost-estimation Equipment-specific cost correlations
Tank Costs docs/process/COST_ESTIMATION_FRAMEWORK.md#tank-cost Storage tank cost estimation (API 650/620)
Expander Costs docs/process/COST_ESTIMATION_FRAMEWORK.md#expander-cost Turboexpander cost estimation
Ejector Costs docs/process/COST_ESTIMATION_FRAMEWORK.md#ejector-cost Ejector and vacuum system costs
Absorber Costs docs/process/COST_ESTIMATION_FRAMEWORK.md#absorber-cost Absorption tower cost estimation
Currency & Location docs/process/COST_ESTIMATION_FRAMEWORK.md#currency-and-location-support Multi-currency and location factors
OPEX Estimation docs/process/COST_ESTIMATION_FRAMEWORK.md#operating-cost-opex-estimation Operating cost calculation
Financial Metrics docs/process/COST_ESTIMATION_FRAMEWORK.md#financial-metrics Payback, ROI, NPV calculations

Chapter 23c: Corrosion Analysis

Document Path Description
Corrosion Module Overview docs/process/corrosion/index.md Package overview, quick start, standards coverage for NORSOK M-506 and M-001
NORSOK M-506 Corrosion Rate docs/process/corrosion/norsok_m506_corrosion_rate.md CO2 corrosion rate prediction — fugacity, pH, correction factors, parameter sweeps, JSON reporting
NORSOK M-001 Material Selection docs/process/corrosion/norsok_m001_material_selection.md Material grade recommendation — sweet/sour classification, CRA selection, chloride SCC, corrosion allowance
Pipeline Corrosion Integration docs/process/corrosion/pipeline_corrosion_integration.md Automated corrosion analysis from process simulation — stream extraction, combined mechanical + corrosion

Chapter 24: Serialization & Persistence

Document Path Description
Process Serialization docs/simulation/process_serialization.md Save/load process models
Process Model Lifecycle docs/process/lifecycle/process_model_lifecycle.md ProcessModelState, versioning, checkpointing, digital twin lifecycle
Process Automation API docs/simulation/process_automation.md String-addressable API for reading/writing simulation variables

Part IV: Pipeline & Multiphase Flow

Chapter 24: Pipeline Fundamentals

Document Path Description
Fluid Mechanics Overview docs/fluidmechanics/README.md Fluid mechanics module
Pipeline Index docs/wiki/pipeline_index.md Pipeline documentation index
Pipeline Simulation docs/process/equipment/pipeline_simulation.md Comprehensive pipeline simulation guide with PipeLineInterface, all pipe types, flow regimes, heat transfer
Flow Equations docs/wiki/pipeline_flow_equations.md Pipeline flow equations
Single Phase Flow docs/fluidmechanics/single_phase_pipe_flow.md Single phase pipe flow
Flow Pattern Detection docs/fluidmechanics/flow_pattern_detection.md Taitel-Dukler, Baker, Barnea models, FlowPatternDetector API

Chapter 25: Pressure Drop Calculations

Document Path Description
Pressure Drop docs/wiki/pipeline_pressure_drop.md Pressure drop calculation
Beggs & Brill docs/wiki/beggs_and_brill_correlation.md Beggs & Brill correlation
Friction Factors docs/wiki/friction_factor_models.md Friction factor models

Chapter 26: Heat Transfer in Pipelines

Document Path Description
Heat Transfer docs/wiki/pipeline_heat_transfer.md Pipeline heat transfer
Heat Transfer Module docs/fluidmechanics/heat_transfer.md Heat transfer module
Pipe Wall docs/wiki/pipe_wall_heat_transfer.md Pipe wall heat transfer
Interphase docs/fluidmechanics/InterphaseHeatMassTransfer.md Interphase heat/mass transfer
Mass Transfer docs/fluidmechanics/mass_transfer.md Mass transfer models
Mass Transfer API docs/fluidmechanics/MassTransferAPI.md Complete API documentation for mass transfer with methods, parameters, and examples
Evaporation & Dissolution Tutorial docs/fluidmechanics/EvaporationDissolutionTutorial.md Practical tutorial for liquid evaporation and gas dissolution with worked examples
Model Improvements docs/fluidmechanics/MASS_TRANSFER_MODEL_IMPROVEMENTS.md Technical review of mass transfer model with improvement recommendations

Chapter 27: Two-Phase & Multiphase Flow

Document Path Description
Two-Phase Model docs/fluidmechanics/TwoPhasePipeFlowModel.md Two-phase pipe flow
Two-Fluid Model docs/wiki/two_fluid_model.md Two-fluid model
Multiphase Transient docs/wiki/multiphase_transient_model.md Multiphase transient
Transient Pipe Wiki docs/wiki/transient_multiphase_pipe.md Transient multiphase pipe
Development Plan docs/fluidmechanics/TwoPhasePipeFlowSystem_Development_Plan.md Development plan

Chapter 28: Transient Pipeline Simulation

Document Path Description
Transient Simulation docs/wiki/pipeline_transient_simulation.md Transient pipeline
Model Recommendations docs/wiki/pipeline_model_recommendations.md Model recommendations
Water Hammer docs/wiki/water_hammer_implementation.md Water hammer

Part V: Safety & Reliability

Chapter 29: Safety Overview

Document Path Description
Safety Overview docs/safety/README.md Safety systems module
Safety Roadmap docs/safety/SAFETY_SIMULATION_ROADMAP.md Safety simulation roadmap
Layered Architecture docs/safety/layered_safety_architecture.md Layered safety architecture
Process Safety docs/process/safety/README.md Process safety module

Chapter 30: Alarm Systems

Document Path Description
Alarm System Guide docs/safety/alarm_system_guide.md Alarm system configuration
Alarm Logic Example docs/safety/alarm_triggered_logic_example.md Alarm-triggered logic
ESD Fire Alarm docs/wiki/esd_fire_alarm_system.md ESD/Fire alarm systems

Chapter 31: Pressure Relief Systems

Document Path Description
PSV Dynamic Sizing Wiki docs/wiki/psv_dynamic_sizing_example.md PSV dynamic sizing
PSV Dynamic Sizing docs/safety/psv_dynamic_sizing_example.md PSV sizing example
Relief Valve Sizing API docs/safety/relief_valve_sizing_api.md API 520/521 PSV sizing for gas, liquid, and two-phase relief with fire heat input
PSD Valve Trip docs/wiki/psd_valve_hihi_trip.md PSD valve HIHI trip
Rupture Disks docs/safety/rupture_disk_dynamic_behavior.md Rupture disk behavior

Chapter 32: HIPPS Systems

Document Path Description
HIPPS Summary docs/safety/HIPPS_SUMMARY.md HIPPS summary
HIPPS Implementation docs/safety/hipps_implementation.md HIPPS implementation
HIPPS Safety Logic docs/safety/hipps_safety_logic.md HIPPS safety logic

Chapter 33: ESD & Fire Systems

Document Path Description
ESD Blowdown docs/safety/ESD_BLOWDOWN_SYSTEM.md ESD blowdown system
Pressure Monitoring docs/safety/PRESSURE_MONITORING_ESD.md Pressure monitoring ESD
Fire Heat Transfer docs/safety/fire_heat_transfer_enhancements.md Fire heat transfer
Fire Blowdown docs/safety/fire_blowdown_capabilities.md Fire blowdown capabilities

Chapter 34: Integrated Safety Systems

Document Path Description
Integrated Safety docs/safety/INTEGRATED_SAFETY_SYSTEMS.md Integrated safety systems
SIS Logic docs/safety/sis_logic_implementation.md SIS logic implementation
Choke Protection docs/wiki/choke_collapse_psd_protection.md Choke collapse protection
Safety Chain Tests docs/safety/integration_safety_chain_tests.md Safety chain tests
Scenario Generation docs/process/safety/scenario-generation.md Automatic scenario generation

Chapter 35: Risk Simulation Framework

Comprehensive operational risk simulation framework for equipment failure analysis, production impact assessment, and degraded operation optimization. Includes Monte Carlo simulation, 5×5 risk matrix, process topology analysis, STID tagging per ISO 14224/NORSOK, and dependency analysis with cross-installation support.

Document Path Description
Risk Framework Index docs/risk/index.md START HERE: Quick start guide, architecture overview, package structure
Framework Overview docs/risk/overview.md Core concepts, capabilities, industry standards compliance (ISO 14224, OREDA, NORSOK)
Equipment Failure Modeling docs/risk/equipment-failure.md FailureType enum, capacity factors, OREDA reliability data, λ/R(t)/MTTF formulas
Risk Matrix docs/risk/risk-matrix.md 5×5 probability/consequence matrix, risk scoring, cost calculations
Monte Carlo Simulation docs/risk/monte-carlo.md OperationalRiskSimulator, exponential sampling, P10/P50/P90 statistics, convergence
Production Impact Analysis docs/risk/production-impact.md Loss calculations, criticality index, cascade analysis, economic impact
Degraded Operation docs/risk/degraded-operation.md DegradedOperationOptimizer, recovery planning, operating modes
Process Topology docs/risk/topology.md ProcessTopologyAnalyzer, graph extraction, topological ordering, DOT/JSON export
STID Tagging docs/risk/stid-tagging.md FunctionalLocation class, PPPP-TT-NNNNN[S] format, installation/equipment codes
Dependency Analysis docs/risk/dependency-analysis.md DependencyAnalyzer, cascade failure trees, cross-installation effects
Mathematical Reference docs/risk/mathematical-reference.md Complete formulas: reliability, system availability, Monte Carlo, risk calculations
API Reference docs/risk/api-reference.md Full API documentation for all risk simulation classes
Reliability Data Guide docs/risk/RELIABILITY_DATA_GUIDE.md OREDA-based reliability data, failure rate sources, equipment categories
Physics-Based Integration docs/risk/PHYSICS_BASED_RISK_INTEGRATION.md Integration of physics-based models with risk simulation for dynamic failure analysis

Chapter 35a: Advanced Risk Framework (NEW)

Extended risk analysis capabilities implementing P1-P7 priority improvements for oil & gas industry applications.

Document Path Description
Advanced Framework Overview docs/risk/README.md START HERE: Overview of all 7 priority packages
P1: Dynamic Simulation docs/risk/dynamic-simulation.md Monte Carlo with transient effects, shutdown/startup modeling
P2: SIS/SIF Integration docs/risk/sis-integration.md IEC 61508/61511, LOPA analysis, SIL verification
P4: Bow-Tie Analysis docs/risk/bowtie-analysis.md Barrier analysis, threat/consequence visualization
P6: Condition-Based Reliability docs/risk/condition-based.md Health monitoring, RUL estimation, predictive maintenance
Tutorial Notebook docs/examples/AdvancedRiskFramework_Tutorial.ipynb Comprehensive Jupyter tutorial

Advanced Risk Framework Packages

Package Purpose Key Classes
process.safety.risk.dynamic P1: Transient simulation DynamicRiskSimulator, ProductionProfile, TransientLossStatistics
process.safety.risk.sis P2: Safety systems SafetyInstrumentedFunction, SISIntegratedRiskModel, LOPAResult
process.safety.risk.realtime P3: Digital twin RealTimeRiskMonitor, RealTimeRiskAssessment
process.safety.risk.bowtie P4: Barrier analysis BowTieAnalyzer, BowTieModel
process.safety.risk.portfolio P5: Portfolio risk PortfolioRiskAnalyzer, PortfolioRiskResult
process.safety.risk.condition P6: CBR ConditionBasedReliability
process.safety.risk.ml P7: ML integration RiskMLInterface, MLPrediction
process.safety.risk.examples Quick-start examples RiskFrameworkQuickStart

Key Classes in Risk Framework

Class Package Purpose
EquipmentFailureMode process.equipment.failure Failure mode definitions with OREDA data
ReliabilityDataSource process.equipment.failure OREDA-based reliability data access
ProductionImpactAnalyzer process.safety.risk Production loss analysis
DegradedOperationOptimizer process.safety.risk Degraded mode optimization
OperationalRiskSimulator process.safety.risk Monte Carlo simulation engine
RiskMatrix process.safety.risk 5×5 risk assessment matrix
ProcessTopologyAnalyzer process.util.topology Process graph extraction
FunctionalLocation process.util.topology STID tag parsing (ISO 14224)
DependencyAnalyzer process.util.topology Equipment dependency analysis

Part VI: PVT & Flow Assurance

Chapter 35: PVT Simulation

Document Path Description
Phase Envelope Guide docs/pvtsimulation/phase_envelope_guide.md Cricondenbar, cricondentherm, HCDP, bubble/dew points
PVT Lab Tests docs/pvtsimulation/pvt_lab_tests.md CCE, CVD, DL, separator test, swelling test simulations
PVT Overview docs/pvtsimulation/README.md PVT simulation module
PVT Workflows docs/wiki/pvt_simulation_workflows.md PVT simulation workflows
PVT Workflow Module docs/pvtsimulation/pvt_workflow.md PVT workflow module
Property Flash docs/wiki/property_flash_workflows.md Property flash workflows
Relative Permeability docs/pvtsimulation/relative_permeability.md Corey and LET relative permeability models, Eclipse table export (SWOF/SGOF/SOF3)
Gas Pseudopressure & Pseudocritical docs/pvtsimulation/gas_pseudopressure_pseudocritical.md Real gas pseudopressure integral, Standing/Sutton/Piper pseudocritical correlations, Wichert-Aziz correction
Whitson Reader docs/pvtsimulation/whitson_pvt_reader.md Whitson PVT reader
Eclipse E300 Fluid Import docs/pvtsimulation/eclipse_e300_fluid_import.md E300 file format reference, reading/writing Eclipse fluids, PVTsim integration, reservoir coupling workflows
JSON Fluid Format docs/pvtsimulation/json_fluid_format.md JSON fluid file format reference, reading/writing/converting fluids, E300 interconversion, API integration
Solution Gas-Water Ratio docs/pvtsimulation/SolutionGasWaterRatio.md Rsw calculation methods (McCain, Søreide-Whitson, Electrolyte CPA)

Chapter 36: Black Oil Models

Document Path Description
Black Oil Overview docs/blackoil/README.md Black oil module
Flash Playbook docs/wiki/black_oil_flash_playbook.md Black oil flash playbook
Black Oil Export docs/pvtsimulation/blackoil_pvt_export.md Black oil PVT export, E300 compositional export, and E300 import with automatic water addition

Chapter 37: Flow Assurance

Document Path Description
Flow Assurance docs/pvtsimulation/flowassurance/README.md Flow assurance module
Asphaltene Modeling docs/pvtsimulation/flowassurance/asphaltene_modeling.md Asphaltene modeling
Asphaltene CPA docs/pvtsimulation/flowassurance/asphaltene_cpa_calculations.md CPA calculations
De Boer Screening docs/pvtsimulation/flowassurance/asphaltene_deboer_screening.md De Boer screening
Method Comparison docs/pvtsimulation/flowassurance/asphaltene_method_comparison.md Method comparison
Parameter Fitting docs/pvtsimulation/flowassurance/asphaltene_parameter_fitting.md Parameter fitting
Validation docs/pvtsimulation/flowassurance/asphaltene_validation.md Validation
Asphaltene Stability Notebook examples/notebooks/AsphalteneStabilityAnalysis.ipynb Jupyter notebook: 6-method asphaltene prediction (De Boer, FH, CPA, Pedersen, RI, benchmark), literature validation (7 cases), parity plot
Flow Assurance Screening Tools docs/pvtsimulation/flowassurance/flow_assurance_screening_tools.md Pipeline cooldown, CO2 corrosion (de Waard-Milliams), scale prediction, wax curve monotonicity
Erosion Prediction docs/pvtsimulation/flowassurance/erosion_prediction.md API RP 14E erosional velocity, DNV RP O501 sand erosion, sand load defaults by completion type, corrosion-limited velocity, risk assessment
Emulsion Viscosity docs/pvtsimulation/flowassurance/emulsion_viscosity_calculator.md Einstein, Taylor, Brinkman, Pal-Rhodes, Woelflin, Richardson models, phase inversion

Chapter 38: Gas Quality

Document Path Description
Gas Quality Standards docs/wiki/gas_quality_standards_from_tests.md Gas quality standards
Humid Air docs/wiki/humid_air_math.md Humid air calculations

Part VII: Standards & Quality

Chapter 39: ISO Standards

Document Path Description
Standards Overview docs/standards/README.md Standards module
ISO 6976 docs/standards/iso6976_calorific_values.md ISO 6976 calorific values
ISO 6578 docs/standards/iso6578_lng_density.md ISO 6578 LNG density
ISO 15403 docs/standards/iso15403_cng_quality.md ISO 15403 CNG quality
Dew Point docs/standards/dew_point_standards.md Dew point standards
ASTM D6377 docs/standards/astm_d6377_rvp.md ASTM D6377 RVP
Oil Quality Standards docs/standards/oil_quality_standards.md ASTM D86, D445, D4052, D4294, D2500, D97, BS&W
Sales Contracts docs/standards/sales_contracts.md Sales contracts
IEC 81346 Reference Designations docs/standards/iec81346-reference-designations.md IEC 81346 structured equipment identification — letter codes, automatic designation generation, hierarchical/flat function numbering, ProcessModel integration, lifecycle state persistence, engineering deliverables, ISA-5.1 cross-reference, DEXPI export, ProcessAutomation integration

Part VIII: Advanced Topics

Chapter 40: Future Infrastructure

Document Path Description
Future Infrastructure docs/process/future-infrastructure.md Future infrastructure classes
API Reference docs/process/future-api-reference.md Future API reference

Chapter 41: Digital Twins

Document Path Description
Digital Twin docs/process/digital-twin-integration.md Digital twin integration
Plant Data & Tagreader docs/process/plant-data-tagreader.md Connecting NeqSim to plant historians (PI/IP.21) via tagreader
Lifecycle docs/process/lifecycle/README.md Lifecycle management

Chapter 42: AI/ML Integration

Document Path Description
AI Platform docs/integration/ai_platform_integration.md AI platform integration
AI Validation docs/integration/ai_validation_framework.md AI validation framework
AI Validation PR docs/integration/PR_AI_VALIDATION_FRAMEWORK.md AI validation PR docs
ML Integration docs/integration/ml_integration.md ML integration guide
ML Surrogate docs/process/ml/README.md ML surrogate models
Integration Overview docs/integration/README.md Integration module
Agentic Engineering Introduction docs/integration/ai_agentic_programming_intro.md NEW: Comprehensive introduction to AI agent-assisted engineering with NeqSim
Agents & Skills Reference docs/integration/ai_agents_reference.md Complete catalog of all 16 agents and 14 skills with commands and examples
Agentic Workflow Examples docs/integration/ai_workflow_examples.md NEW: Step-by-step walkthroughs of agent-driven engineering workflows
Agentic Java Classes docs/integration/ai_agentic_classes.md TaskResultValidator, SimulationQualityGate, AgentSession, AgentFeedbackCollector — Java infrastructure for AI-driven simulation QA

Chapter 43: Sustainability & Emissions

Document Path Description
Emissions Tracking docs/process/sustainability/README.md Emissions tracking overview
Offshore Emission Reporting Guide docs/emissions/OFFSHORE_EMISSION_REPORTING.md Comprehensive guide for offshore platform GHG emission reporting with regulatory references
Produced Water Emissions Tutorial docs/examples/ProducedWaterEmissions_Tutorial.md Comprehensive tutorial for produced water degassing emissions calculation
Norwegian Emission Methods Comparison docs/examples/NorwegianEmissionMethods_Comparison.md NeqSim vs Norwegian handbook method: validation, uncertainty, regulatory compliance
GFMW 2023 Reference External publication “Virtual Measurement of Emissions from Produced Water Using an Online Process Simulator” - Kristiansen et al., GFMW 2023

Chapter 44: Optimization

Document Path Description
Optimization Overview docs/process/optimization/README.md Optimization module
Flow Rate Optimization docs/process/optimization/flow-rate-optimization.md Comprehensive flow rate optimizer with lift curve generation for Eclipse reservoir simulation
Multi-Objective Optimization docs/process/optimization/multi-objective-optimization.md Pareto front generation for competing objectives (throughput vs energy)
Constraint Framework docs/process/optimization/constraint-framework.md Unified ProcessConstraint interface bridging equipment, internal, and external optimizer constraints
Data Reconciliation and Steady-State Detection docs/process/optimization/data-reconciliation.md R-statistic steady-state detection, WLS data reconciliation, gross error detection, SSD-to-reconciliation bridge
Batch Studies docs/process/optimization/batch-studies.md Batch studies
Bottleneck Analysis docs/wiki/bottleneck_analysis.md Bottleneck analysis and ProductionOptimizer
Multi-Variable Optimization docs/wiki/bottleneck_analysis.md#multi-variable-optimization-with-manipulatedvariable ManipulatedVariable for split factors, dual feeds, pressure setpoints
Calibration docs/process/calibration/README.md Model calibration
Data Reconciliation → Parameter Estimation Workflow docs/calibration/data_reconciliation_parameter_estimation.md End-to-end plant-data-to-model-tuning: DataReconciliationEngine, BatchParameterEstimator (L-M), EnKF, Python helper
Advisory docs/process/advisory/README.md Advisory systems

Chapter 45: Real-Time Integration

Document Path Description
Real-Time Guide docs/integration/REAL_TIME_INTEGRATION_GUIDE.md Real-time integration
MPC Integration docs/integration/mpc_integration.md MPC integration
Industrial MPC docs/integration/neqsim_industrial_mpc_integration.md Industrial MPC

Chapter 46: External Integrations

Document Path Description
DEXPI P&ID Import, Export & Visualization docs/integration/dexpi-reader.md DEXPI import/export/round-trip, ISO 10628 shapes, auto-layout, instruments, SIL markers, fail-position, mechanical design, stream table, drawing border, symbol legend, configurable layout, topology, equipment factory, simulation builder
QRA Integration docs/integration/QRA_INTEGRATION_GUIDE.md QRA integration

Chapter 47: Process Logic Framework

Document Path Description
Simulation Overview docs/simulation/README.md Simulation module
Process Logic docs/simulation/process_logic_framework.md Process logic framework
Advanced Logic docs/simulation/advanced_process_logic.md Advanced process logic
Implementation docs/simulation/process_logic_implementation_summary.md Implementation summary
Enhancements docs/simulation/ProcessLogicEnhancements.md Logic enhancements
Runtime Flexibility docs/simulation/RuntimeLogicFlexibility.md Runtime flexibility
Graph-Based docs/simulation/graph_based_process_simulation.md Graph-based simulation
Parallel Simulation docs/simulation/parallel_process_simulation.md Parallel simulation
Recycle Acceleration docs/simulation/recycle_acceleration_guide.md Recycle acceleration
Process Calculator docs/simulation/process_calculator.md Process calculator
Integrated Workflow docs/simulation/INTEGRATED_WORKFLOW_GUIDE.md Integrated workflow
Differentiable Thermo docs/simulation/differentiable_thermodynamics.md Auto-differentiation
Derivatives docs/simulation/derivatives_and_gradients.md Derivatives and gradients
Equipment Factory docs/simulation/equipment_factory.md Equipment factory

Chapter 48: Field Development

Document Path Description
Field Development Overview docs/fielddevelopment/README.md Field development module overview
Digital Field Twin docs/fielddevelopment/DIGITAL_FIELD_TWIN.md NEW Comprehensive architecture for lifecycle consistency
Mathematical Reference docs/fielddevelopment/MATHEMATICAL_REFERENCE.md NEW Mathematical foundations for all calculations
API Guide docs/fielddevelopment/API_GUIDE.md NEW Detailed usage examples for all components
Integrated Framework docs/fielddevelopment/INTEGRATED_FIELD_DEVELOPMENT_FRAMEWORK.md PVT→Reservoir→Well→Process integration guide
Strategy docs/fielddevelopment/FIELD_DEVELOPMENT_STRATEGY.md Field development strategy and roadmap
Late-Life Operations docs/fielddevelopment/LATE_LIFE_OPERATIONS.md Turndown, debottlenecking, and decommissioning timing analysis
Multi-Scenario VFP Generation docs/fielddevelopment/MULTI_SCENARIO_PRODUCTION_OPTIMIZATION.md VFP tables with varying GOR/water cut for reservoir simulation coupling
Field Planning docs/wiki/field_development_planning.md Field development planning
Field Engine docs/simulation/field_development_engine.md Field development engine
Economics docs/process/economics/README.md Economics module: NPV, IRR, tax models, decline curves
Subsea Systems docs/process/equipment/subsea_systems.md Subsea production systems, tieback analysis

Digital Field Twin Lifecycle Components

Lifecycle Phase Documentation Key Capabilities
Screening (DG0-DG1) DIGITAL_FIELD_TWIN §3 Concept comparison, flow assurance screening, tieback analysis
Selection (DG2) MATHEMATICAL_REFERENCE §4-5 NPV calculation, MCDA ranking, Norwegian tax model
Definition (DG3) API_GUIDE §5-6 Process system auto-generation, network modeling
Execution (DG4) DIGITAL_FIELD_TWIN §4 VFP table export, reservoir coupling
Operations DIGITAL_FIELD_TWIN §5 Real-time optimization, Monte Carlo uncertainty
Late-Life LATE_LIFE_OPERATIONS Turndown, debottlenecking, decommissioning timing

New Classes in This PR

Class Package Purpose
CashFlowEngine economics Full-lifecycle NPV with tax models
NorwegianTaxModel economics NCS fiscal regime (22% + 56%)
SURFCostEstimator subsea SURF CAPEX with regional factors
PortfolioOptimizer economics Multi-project investment optimization
DevelopmentOptionRanker evaluation MCDA-based concept ranking
MonteCarloRunner evaluation Probabilistic uncertainty analysis
ConceptToProcessLinker facility Auto-generate ProcessSystem from concept
MultiphaseFlowIntegrator network Pipeline hydraulics integration
ReservoirCouplingExporter reservoir VFP tables and ECLIPSE keywords
TiebackAnalyzer tieback Tieback feasibility screening

Part IX: Developer Guide

Chapter 49: Contributing

Document Path Description
Development Overview docs/development/README.md Development overview
Contributing Structure docs/development/contributing-structure.md Contributing guidelines
Developer Setup docs/development/DEVELOPER_SETUP.md Developer setup
Extending Process Equipment docs/development/extending_process_equipment.md Add custom equipment, stream introspection, MultiPortEquipment base class
Extending Physical Properties docs/development/extending_physical_properties.md NEW: Add viscosity, conductivity, diffusivity models
Extending Thermodynamic Models docs/development/extending_thermodynamic_models.md NEW: Add custom equations of state
Python Extension Patterns docs/development/python_extension_patterns.md NEW: Python integration, wrappers, JPype interfaces
Jupyter Development Workflow docs/development/jupyter_development_workflow.md Live Java development from Jupyter notebooks with auto-compile and kernel restart
Task Solving Guide docs/development/TASK_SOLVING_GUIDE.md Step-by-step workflow for solving engineering tasks
Code Patterns docs/development/CODE_PATTERNS.md Copy-paste starters for common coding tasks
Task Log docs/development/TASK_LOG.md Searchable log of all solved tasks

Chapter 50: Testing

Document Path Description
Test Overview docs/wiki/test-overview.md Test overview
Flash Tests docs/wiki/flash_equations_and_tests.md Flash equation tests
Safety Tests docs/safety/integration_safety_chain_tests.md Safety chain tests

Chapter 51: Notebooks & Examples

Document Path Description
Reading Fluid Properties docs/examples/ReadingFluidProperties.md NEW: Comprehensive guide to reading thermodynamic and physical properties
Colab Notebooks docs/wiki/java_simulation_from_colab_notebooks.md Colab notebooks
Transient Slug Example docs/examples/transient_slug_separator_control_example.md Transient slug example
Selective Logic docs/examples/selective-logic-execution.md Selective logic execution
Comparison Quickstart docs/examples/comparesimulations_quickstart.md Simulation comparison
PVT Simulation & Tuning docs/examples/PVT_Simulation_and_Tuning.md PVT simulation setup, EoS tuning, and characterization examples
TVP/RVP Study docs/examples/TVP_RVP_Study.md True Vapor Pressure and Reid Vapor Pressure calculations
ESP Pump Tutorial docs/examples/ESP_Pump_Tutorial.md Electric Submersible Pump simulation and sizing
Graph-Based Simulation docs/examples/GraphBasedProcessSimulation.md Graph-based process simulation tutorial
Field Development Workflow docs/examples/FieldDevelopmentWorkflow.md End-to-end field development workflow example
Multi-Scenario VFP Tutorial docs/examples/MultiScenarioVFP_Tutorial.ipynb VFP generation with varying GOR/water cut scenarios
Production System Bottleneck Analysis docs/examples/ProductionSystem_BottleneckAnalysis.ipynb Multi-well system optimization, bottleneck identification, and well prioritization
Integrated Production & Risk Analysis docs/examples/IntegratedProductionRiskAnalysis.ipynb Complete operational workflow combining bottleneck analysis with risk simulation, Monte Carlo, and risk matrix
LNG Heat Exchanger Demo examples/notebooks/LNGHeatExchanger_ComprehensiveDemo.ipynb Comprehensive BAHX demo: composite curves, exergy, adaptive zones, Manglik-Bergles, transient cool-down, core sizing, freeze-out, maldistribution, mechanical design, cost estimation, SMR cycle
LNG Ageing Basics examples/notebooks/lng_ageing_basics.ipynb Single-tank LNG ageing simulation: composition evolution, BOG, Wobbe index, voyage profiles
LNG Ageing Advanced examples/notebooks/lng_ageing_advanced.ipynb Advanced LNG ageing: tank geometry, sloshing, methane number, rollover detection, multi-zone heat transfer
LNG Ship Voyage examples/notebooks/lng_ship_voyage.ipynb Multi-tank Q-Max carrier voyage: per-tank evolution, shared BOG handling, ship-level KPIs
MPC Integration Tutorial docs/examples/MPC_Integration_Tutorial.md Model Predictive Control integration example
AI Platform Integration docs/examples/AIPlatformIntegration.md AI platform integration tutorial
Beer Brewing Bio-Process docs/examples/BeerBrewing_BioProcess_Simulation.md Bio-process simulation for brewing applications
H2S Distribution Modeling docs/examples/H2S_Distribution_Modeling.md H2S distribution and partitioning across phases
Multiphase Flow Pipeline Riser docs/examples/MultiphaseFlowPipelineRiser_Interactive.md Interactive multiphase pipeline-riser simulation
Looped Pipeline Network docs/examples/LoopedPipelineNetworkExample.md Looped pipeline network simulation example
Advanced Risk Framework docs/examples/AdvancedRiskFramework_Tutorial.md Advanced risk framework tutorial
Two-Fluid Pipe Tutorial docs/examples/TwoFluidPipe_Tutorial.md Two-fluid pipe model tutorial
Examples Index docs/examples/index.md Examples documentation index

Chapter 52: Documentation Infrastructure

Document Path Description
GitHub Pages Setup docs/GITHUB_PAGES_SETUP.md NEW Enable GitHub Pages for hosted documentation
Reference Manual docs/manual/neqsim_reference_manual.html Interactive reference manual
Documentation Index docs/index.md GitHub Pages home page

Appendices

Appendix A: Chemical Reactions

Document Path Description
Chemical Reactions docs/chemicalreactions/README.md Chemical reactions module
Deep Review docs/chemicalreactions/CHEMICAL_REACTION_DEEP_REVIEW.md Chemical reaction deep review
Sulfur Deposition Analysis docs/chemicalreactions/sulfur_deposition_analysis.md Sulfur formation, solubility, deposition, and FeS corrosion

Appendix B: Statistics

Document Path Description
Statistics docs/statistics/README.md Statistics module
Parameter Fitting docs/statistics/parameter_fitting.md Parameter fitting
Monte Carlo docs/statistics/monte_carlo_simulation.md Monte Carlo simulation
Data Analysis docs/statistics/data_analysis.md Data analysis

Appendix C: Mathematical Library

Document Path Description
Math Library docs/mathlib/README.md Mathematical library

Appendix D: Utilities

Document Path Description
Utilities docs/util/README.md Utility functions
Unit Conversion docs/util/unit_conversion.md Unit conversion guide
Unit Conversion Recipes docs/cookbook/unit-conversion-recipes.md NEW Quick reference for all supported unit strings
Optimizer Guide docs/util/optimizer_guide.md NEW Comprehensive optimization framework with BFGS, Pareto, sensitivity analysis

Appendix F: Process Design Templates

Document Path Description
Templates Guide docs/process/design/templates_guide.md NEW Pre-built process templates (compression, dehydration, CO2 capture)

Appendix G: Mechanical Design Standards

Document Path Description
TEMA Standard Guide docs/process/mechanical_design/tema_standard_guide.md NEW TEMA shell and tube heat exchanger design standards
Thermal-Hydraulic Design docs/process/mechanical_design/thermal_hydraulic_design.md NEW Tube/shell HTC (Gnielinski, Kern, Bell-Delaware), overall U, pressure drops, LMTD correction, vibration screening, rating mode
Two-Phase Heat Transfer docs/process/mechanical_design/two_phase_heat_transfer.md NEW Shah condensation, Chen/Gungor-Winterton boiling, Friedel/MSH two-phase pressure drop, Ebert-Panchal fouling, incremental zone analysis, tube inserts

Appendix H: Cookbook (Quick Recipes)

Document Path Description
Cookbook Index docs/cookbook/index.md NEW Quick copy-paste recipes for common tasks
Thermodynamics Recipes docs/cookbook/thermodynamics-recipes.md Fluids, flash, properties, phase envelopes
Process Recipes docs/cookbook/process-recipes.md Separators, compressors, heat exchangers
Pipeline Recipes docs/cookbook/pipeline-recipes.md Pressure drop, multiphase flow
Adsorption Recipes docs/cookbook/adsorption-recipes.md Adsorption bed simulation recipes and workflows

Appendix I: Troubleshooting

Document Path Description
Troubleshooting Guide docs/troubleshooting/index.md NEW Solutions to common problems

Appendix E: Wiki Reference

Document Path Description
Wiki Overview docs/wiki/README.md Wiki documentation

Document Statistics

Category Count
Wiki/Tutorials 60
Thermodynamics 26
Process Simulation 47
Safety Systems 18
Risk Simulation 13
Field Development 11
Integration/AI 12
Pipeline/Flow 17
PVT/Reservoir 15
Standards 6
Development 11
Statistics 4
Examples 19
Optimization 5
Templates & Design 2
Quickstart Guides 4
Cookbook 6
Tutorials/Learning 2
Troubleshooting 1
Other 24
Total 303
  1. Start Here: If new to NeqSim, begin with Quickstart Guides or Getting Started
  2. Learning Path: Follow the Learning Paths for structured learning
  3. Quick Recipes: Use the Cookbook for copy-paste solutions
  4. By Task: Use the chapter structure above to find relevant sections
  5. By Equipment: See Part III, Chapters 13-20 for equipment-specific docs
  6. For Developers: Jump to Part IX for contribution guidelines
  7. Problems?: Check the Troubleshooting Guide
  8. Process Serialization: See Chapter 23 for save/load

This index was updated after comprehensive documentation review. Last updated: February 2026