This section contains tutorials, code examples, and Jupyter notebooks demonstrating NeqSim capabilities.

Maintained workflow notebooks

These repository workflows live under examples/notebooks/ and are maintained with their engineering guides. Their rows describe the validation evidence stored with each notebook; follow the linked guide for exact scope and limitations.

Notebook	Description	View Options
Complete Offshore Process Engineering Study	Full three-stage oil/gas process benchmark, closed design loop, discipline results, closed-loop SIF/reliability/HAZOP-LOPA-SRS/facility-response lifecycle, revisioned model packages, change revalidation, method benchmarks, and inline PyDEXPI P&ID rendering	Guide | nbviewer | Colab
Full DEXPI Engineering ProcessSystem	Executed line-list, relief, SIL/PFD/voting, shutdown, PSV, blowdown/flare, materials, readiness, and governed DEXPI workflow	nbviewer | Colab
DEXPI Engineering ProcessModel	Executed multi-area packages with area-specific engineering inputs and readiness comparison	nbviewer | Colab
DEXPI P&ID Visualization	Executed, dependency-light native DEXPI/Proteus parser and deterministic structural P&ID PNG/SVG renderer with a committed figure	nbviewer | Colab
Energy Network Dispatch and Reporting	Executed multi-source and multi-load electrical dispatch with priorities, shortage and curtailment allocation, cost, emissions, and auditable network reports	nbviewer | Colab
Rotating Equipment and Converter Maps	Executed motor and VFD part-load performance, shaft coupling, and load-dependent generator and prime-mover efficiency maps	nbviewer | Colab
Thermal Utilities and Hydraulics	Executed utility mass-flow, temperature-quality, exergy, cooling-water pressure-drop, and pump-power screening workflow	nbviewer | Colab
Chronological Offshore Energy Benchmark	Executed time-series energy balance, generator commitment, operating-cost and CO2 accounting, and offshore wind-gas benchmark	nbviewer | Colab

Local notebook catalog

Stored status describes the committed notebook only; it is not a rerun against the current master branch:

• Executed — every code cell has a stored execution count and there is no stored exception or standard-error stream.
• Partial — some, but not all, code cells have stored execution counts.
• Source only — no code cell has a stored execution count.

For engineering use, rerun from a clean environment, inspect all outputs, and validate the model, units, assumptions, and operating range. A rendered Markdown page is a reading aid, not execution evidence.

Stored status	Notebook	Description	View options
Source only	NeqSim AI Platform Integration	Notebook for NeqSim AI Platform Integration, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	NeqSim Advanced Risk Framework Tutorial	Notebook for NeqSim Advanced Risk Framework Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	Beer Brewing Process Simulation with NeqSim Bio-Processing	Notebook for Beer Brewing Process Simulation with NeqSim Bio-Processing, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	ESP Pump Tutorial	Notebook for ESP Pump Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Transparent field-development screening	Executable NeqSim tutorial for unit-safe gas-production profiles, after-tax cash flow, and bounded sensitivities.	Markdown | nbviewer | Colab
Executed	GERG-2008-NH3: Ammonia Thermodynamic Properties	Notebook for GERG-2008-NH3: Ammonia Thermodynamic Properties, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	GraphBasedProcessSimulation	Notebook for GraphBasedProcessSimulation, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	H2S Distribution Between Gas, Oil, and Water Phases in NeqSim	Notebook for H2S Distribution Between Gas, Oil, and Water Phases in NeqSim, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Integrated Production & Risk Analysis	Notebook for Integrated Production & Risk Analysis, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	Looped Pipeline Network Solver - Hardy Cross Method	Notebook for Looped Pipeline Network Solver - Hardy Cross Method, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	MPC Integration Tutorial	Notebook for MPC Integration Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Mercury Removal in LNG Pre-Treatment	Executable NeqSim mercury-removal screening with transient loading, preliminary design and cost boundaries, and internal verification	Markdown | nbviewer | Colab
Partial	Multi-Scenario VFP Generation with NeqSim	Notebook for Multi-Scenario VFP Generation with NeqSim, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	🌊 Interactive Multiphase Pipeline & S-Riser Simulation	Notebook for 🌊 Interactive Multiphase Pipeline & S-Riser Simulation, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	NeqSim Process Optimization with Python	Notebook for NeqSim Process Optimization with Python, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	Multi-Well Network Solver Tutorial	Notebook for Multi-Well Network Solver Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	PVT Simulation and Tuning	Notebook for PVT Simulation and Tuning, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	🌱 Produced Water Emissions Calculation with NeqSim	Notebook for 🌱 Produced Water Emissions Calculation with NeqSim, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Source only	ProductionOptimizer - Comprehensive Tutorial	Notebook for ProductionOptimizer - Comprehensive Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Production System Optimization & Bottleneck Analysis	Notebook for Production System Optimization & Bottleneck Analysis, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Reading Fluid Properties with Python	Executed NeqSim Python tutorial for thermodynamic, transport, phase, component, unit-conversion, interfacial, and JSON property workflows.	Markdown | nbviewer | Colab
Executed	Reservoir-to-Market Debottleneck Portfolio	Executed, unit-safe NeqSim workflow for paired installed-capacity studies, deterministic alternative ranking, restoration, conservation, serialization, and fail-closed diagnostics.	Markdown | nbviewer | Colab
Executed	Separator & Gas Scrubber Separation Efficiency	Notebook for Separator & Gas Scrubber Separation Efficiency, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	True Vapor Pressure (TVP) vs Reid Vapor Pressure (RVP) Study	Notebook for True Vapor Pressure (TVP) vs Reid Vapor Pressure (RVP) Study, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	TwoFluidPipe Model Tutorial	Notebook for TwoFluidPipe Model Tutorial, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Auto-size & optimize: three production-optimization workflows	Notebook for Auto-size & optimize: three production-optimization workflows, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Executed	Oil & Gas Topside: Production & Energy Optimization	Notebook for Oil & Gas Topside: Production & Energy Optimization, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	Reservoir-to-Market Optimisation with NeqSim Process Equipment	Executed reservoir-to-market process-equipment workflow with field-life depletion, well and flowline hydraulics, export compression, production optimisation, and value-chain economics.	Markdown | nbviewer | Colab
Executed	Plant-wide optimization of a multi-area ProcessModel	Notebook for Plant-wide optimization of a multi-area ProcessModel, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab
Partial	Reservoir-to-Market Optimisation with NeqSim Process Equipment	Notebook for Reservoir-to-Market Optimisation with NeqSim Process Equipment, including NeqSim Python examples and workflow context.	Markdown | nbviewer | Colab

Standalone Java source examples

These files are outside Maven’s compiled source tree. They are retained as source-only references and are not catalogued as build-verified or policy-compliant examples. They currently contain legacy console output; review and port the required calls into a tested src/test/java example before reuse. For a supported starting point, use the Java getting-started guide.

Example	Stored status	Capability
EclipseE300ExportImportExample	Source only	Eclipse E300 fluid export and import workflow
FlowRegimeDebug	Source only	Flow-regime diagnostic calculations
FlowRegimeDetectionExample	Source only	Flow-regime detection across operating cases
MultiScenarioVFPExample	Source only	Multi-scenario vertical-flow-performance comparison
MultiphaseModelPressureDropComparison	Source only	Multiphase pressure-drop model comparison
OffshoreEmissionReportingExample	Source only	Offshore emissions accounting workflow
RealTimeIntegrationExample	Source only	Real-time process-data integration pattern
SlugTrackingComparisonExample	Source only	Slug-tracking model comparison
TransientPipelineLiquidAccumulationExample	Source only	Transient pipeline liquid-accumulation study
TwoFluidPipeExample	Source only	Two-fluid pipe setup and reporting
TwoFluidPipeSlugTrackingExample	Source only	Two-fluid slug-tracking workflow
TwoFluidPipelineLiquidAccumulationExample	Source only	Two-fluid pipeline accumulation study
TwoFluidVsDriftFluxComparisonExample	Source only	Two-fluid and drift-flux comparison
WellToOilStabilizationExample	Source only	Well-to-oil-stabilization process workflow

Other Tutorials

Additional documentation and guides:

• Norwegianemissionmethods Comparison
• Production Optimization Guide
• Comparesimulations Quickstart
• Selective Logic Execution
• Transient Slug Separator Control Example

---

Running the Notebooks

Prerequisites

1. Install neqsim-python:

   pip install neqsim
   

2. Or open a Google Colab link above. Run and inspect the notebook’s setup cell first; dependency installation and stored execution status vary by notebook.

Local Jupyter Setup

# Create a virtual environment
python -m venv neqsim-env
source neqsim-env/bin/activate  # On Windows: neqsim-env\Scripts\activate

# Install dependencies
pip install neqsim jupyter matplotlib pandas numpy

# Start Jupyter
jupyter notebook

Then open any of the .ipynb files from this directory.