This section contains tutorials, code examples, and Jupyter notebooks demonstrating NeqSim capabilities.
Jupyter Notebook Tutorials
Interactive Python notebooks using NeqSim through neqsim-python:
| 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 |
| AIPlatformIntegration | See notebook for details | Markdown | nbviewer | Colab |
| AdvancedRiskFramework Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| BeerBrewing BioProcess Simulation | See notebook for details | Markdown | nbviewer | Colab |
| ESP Pump Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| Transparent field-development screening | Executable NeqSim tutorial for unit-safe gas-production profiles, after-tax cash flow, and bounded sensitivities. | Markdown | nbviewer | Colab |
| GERG2008 NH3 Ammonia Properties | See notebook for details | Markdown | nbviewer | Colab |
| GraphBasedProcessSimulation | See notebook for details | Markdown | nbviewer | Colab |
| H2S Distribution Modeling | See notebook for details | Markdown | nbviewer | Colab |
| IntegratedProductionRiskAnalysis | See notebook for details | Markdown | nbviewer | Colab |
| LoopedPipelineNetworkExample | See notebook for details | Markdown | nbviewer | Colab |
| MPC Integration Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| MercuryRemoval LNG Pretreatment | See notebook for details | Markdown | nbviewer | Colab |
| MultiScenarioVFP Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| MultiphaseFlowPipelineRiser Interactive | See notebook for details | Markdown | nbviewer | Colab |
| NeqSim Python Optimization | See notebook for details | Markdown | nbviewer | Colab |
| NetworkSolverTutorial | See notebook for details | Markdown | nbviewer | Colab |
| PVT Simulation and Tuning | See notebook for details | Markdown | nbviewer | Colab |
| ProducedWaterEmissions Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| ProductionOptimizer Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| ProductionSystem BottleneckAnalysis | See notebook for details | Markdown | nbviewer | Colab |
| Reading Fluid Properties with Python | Executed NeqSim Python tutorial for thermodynamic, transport, phase, component, unit-conversion, interfacial, and JSON property workflows. | Markdown | nbviewer | Colab |
| SeparatorEfficiency GasScrubber ThreePhase | See notebook for details | Markdown | nbviewer | Colab |
| TVP RVP Study | See notebook for details | Markdown | nbviewer | Colab |
| TwoFluidPipe Tutorial | See notebook for details | Markdown | nbviewer | Colab |
| autosize and optimize workflows | See notebook for details | Markdown | nbviewer | Colab |
| oilgas production energy optimization | See notebook for details | Markdown | nbviewer | Colab |
| 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 |
| processmodel plant optimization | See notebook for details | Markdown | nbviewer | Colab |
| reservoir to market optimization | See notebook for details | Markdown | nbviewer | Colab |
Java Examples
Example Java code demonstrating NeqSim APIs:
| Example | Description |
|---|---|
| EclipseE300ExportImportExample | Java example |
| FlowRegimeDebug | Java example |
| FlowRegimeDetectionExample | Java example |
| MultiScenarioVFPExample | Java example |
| MultiphaseModelPressureDropComparison | Java example |
| OffshoreEmissionReportingExample | Java example |
| RealTimeIntegrationExample | Java example |
| SlugTrackingComparisonExample | Java example |
| TransientPipelineLiquidAccumulationExample | Java example |
| TwoFluidPipeExample | Java example |
| TwoFluidPipeSlugTrackingExample | Java example |
| TwoFluidPipelineLiquidAccumulationExample | Java example |
| TwoFluidVsDriftFluxComparisonExample | Java example |
| WellToOilStabilizationExample | Java example |
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
- Install neqsim-python:
pip install neqsim - Or use Google Colab (click the Colab links above) - no installation needed!
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.