Skip to content

Commit 9c033bc

Browse files
committed
update docs
1 parent b334cc2 commit 9c033bc

File tree

10 files changed

+3322
-1
lines changed

10 files changed

+3322
-1
lines changed

docs/REFERENCE_MANUAL_INDEX.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -310,8 +310,9 @@ Fluid characterization handles plus fraction splitting, property estimation, and
310310
| Power Generation | [docs/process/equipment/power_generation.md](process/equipment/power_generation) | Gas turbines, fuel cells, renewables |
311311
| Diff. Pressure | [docs/process/equipment/differential_pressure.md](process/equipment/differential_pressure) | Orifice plates, flow measurement |
312312
| Manifolds | [docs/process/equipment/manifolds.md](process/equipment/manifolds) | Multi-stream routing |
313-
| Battery Storage | [docs/wiki/battery_storage.md](wiki/battery_storage) | Battery storage |
313+
| **Battery Storage** | [docs/process/equipment/battery_storage.md](process/equipment/battery_storage) | **Energy storage systems, charge/discharge cycles, grid integration** |
314314
| Solar Panel | [docs/wiki/solar_panel.md](wiki/solar_panel) | Solar panel models |
315+
| **Failure Mode Modeling** | [docs/process/equipment/failure_modes.md](process/equipment/failure_modes) | **Equipment failure modes, reliability analysis, MTBF/MTTR calculations** |
315316

316317
### Chapter 19: Wells, Pipelines & Subsea
317318

@@ -328,13 +329,18 @@ Fluid characterization handles plus fraction splitting, property estimation, and
328329
| **Risers** | [docs/process/equipment/pipelines.md#risers](process/equipment/pipelines#risers) | **SCR, TTR, Flexible, Lazy-Wave risers** |
329330
| Beggs & Brill | [docs/process/PipeBeggsAndBrills.md](process/PipeBeggsAndBrills) | Beggs & Brill correlation |
330331
| Networks | [docs/process/equipment/networks.md](process/equipment/networks) | Pipeline network modeling |
332+
| **Looped Pipeline Networks** | [docs/process/equipment/looped_networks.md](process/equipment/looped_networks) | **Hardy Cross solver, ring mains, parallel pipelines, loop detection** |
331333
| **Looped Network Solver** | [docs/process/PIPELINE_NETWORK_SOLVER_ENHANCEMENT.md](process/PIPELINE_NETWORK_SOLVER_ENHANCEMENT) | **Hardy Cross looped network solver for ring mains and parallel pipelines** |
332334
| **Looped Network Tutorial** | [docs/examples/LoopedPipelineNetworkExample.ipynb](examples/LoopedPipelineNetworkExample.ipynb) | **Interactive notebook: ring mains, offshore rings, loop detection, Hardy Cross** |
333335
| **Network Solver Tutorial** | [docs/examples/NetworkSolverTutorial.md](examples/NetworkSolverTutorial) | **Tutorial for pipeline network solvers with worked examples** |
334336
| **Pipe Fittings & Equivalent Length** | [docs/process/PIPE_FITTINGS_EQUIVALENT_LENGTH.md](process/PIPE_FITTINGS_EQUIVALENT_LENGTH) | **Equivalent length method for fittings: elbows, tees, valves, reducers per CRANE TP-410** |
335337
| Reservoirs | [docs/process/equipment/reservoirs.md](process/equipment/reservoirs) | Reservoir modeling |
336338
| Subsea Systems | [docs/process/equipment/subsea_systems.md](process/equipment/subsea_systems) | Subsea wells and flowlines |
337339
| Subsea Equipment | [docs/process/equipment/subsea_equipment.md](process/equipment/subsea_equipment) | SubseaWell, SimpleFlowLine, flow assurance |
340+
| **Subsea Trees** | [docs/process/equipment/subsea_trees.md](process/equipment/subsea_trees) | **Christmas trees: horizontal/vertical, dual-bore, valve configurations, wellhead integration** |
341+
| **Subsea Manifolds** | [docs/process/equipment/subsea_manifolds.md](process/equipment/subsea_manifolds) | **Production/injection manifolds, valve skids, well routing, gathering systems** |
342+
| **Subsea Boosters** | [docs/process/equipment/subsea_boosters.md](process/equipment/subsea_boosters) | **Subsea pumps & compressors, helico-axial/multiphase, performance curves** |
343+
| **Umbilicals** | [docs/process/equipment/umbilicals.md](process/equipment/umbilicals) | **Control umbilicals: hydraulic, electrical, chemical injection lines** |
338344
| **SURF Subsea Equipment** | [docs/process/SURF_SUBSEA_EQUIPMENT.md](process/SURF_SUBSEA_EQUIPMENT) | **Comprehensive SURF equipment: PLET, PLEM, manifolds, trees, jumpers, umbilicals, flexible pipes, boosters with mechanical design and cost estimation** |
339345

340346
### Chapter 20: Utility Equipment

docs/process/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,15 @@ This documentation is organized into the following sections:
129129
| Filters | [filters.md](equipment/filters) | Filter, CharCoalFilter |
130130
| Reactors | [reactors.md](equipment/reactors) | GibbsReactor |
131131
| Pipelines | [pipelines.md](equipment/pipelines) | Pipeline, AdiabaticPipe, TopsidePiping, Riser |
132+
| Looped Networks | [looped_networks.md](equipment/looped_networks) | LoopedPipeNetwork, Hardy Cross solver |
132133
| Tanks | [tanks.md](equipment/tanks) | Tank, VesselDepressurization |
133134
| Wells | [wells.md](equipment/wells) | Well equipment |
135+
| Subsea Trees | [subsea_trees.md](equipment/subsea_trees) | SubseaTree, valve control |
136+
| Subsea Manifolds | [subsea_manifolds.md](equipment/subsea_manifolds) | SubseaManifold |
137+
| Subsea Boosters | [subsea_boosters.md](equipment/subsea_boosters) | SubseaBooster, multiphase pumps |
138+
| Umbilicals | [umbilicals.md](equipment/umbilicals) | Umbilical systems |
139+
| Battery Storage | [battery_storage.md](equipment/battery_storage) | BatteryStorage |
140+
| Failure Modes | [failure_modes.md](equipment/failure_modes) | EquipmentFailureMode, reliability |
134141
| Mixers/Splitters | [mixers_splitters.md](equipment/mixers_splitters) | Mixer, Splitter |
135142
| Utility | [util/](equipment/util/) | Adjuster, Recycle, Calculator |
136143

docs/process/equipment/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,13 +73,23 @@ This folder contains detailed documentation for all process equipment in NeqSim.
7373
| Reservoirs | [reservoirs.md](reservoirs) | Material balance reservoir modeling |
7474
| Subsea Systems | [subsea_systems.md](subsea_systems) | Subsea wells and flowlines |
7575

76+
### Subsea Equipment
77+
78+
| Equipment | File | Description |
79+
|-----------|------|-------------|
80+
| Subsea Trees | [subsea_trees.md](subsea_trees) | Christmas trees, valve control |
81+
| Subsea Manifolds | [subsea_manifolds.md](subsea_manifolds) | Multi-slot production manifolds |
82+
| Subsea Boosters | [subsea_boosters.md](subsea_boosters) | Multiphase pumps, compressors |
83+
| Umbilicals | [umbilicals.md](umbilicals) | Hydraulic, chemical, electrical supply |
84+
7685
### Pipeline/Network
7786

7887
| Equipment | File | Description |
7988
|-----------|------|-------------|
8089
| Pipelines | [pipelines.md](pipelines) | Pipe flow, pressure drop |
8190
| **Risers** | [pipelines.md#risers](pipelines#risers) | **SCR, TTR, Flexible, Lazy-Wave risers** |
8291
| Networks | [networks.md](networks) | Pipeline network modeling |
92+
| Looped Networks | [looped_networks.md](looped_networks) | Hardy Cross solver for loops |
8393
| Manifolds | [manifolds.md](manifolds) | Multi-stream routing |
8494

8595
### Flow Measurement
@@ -105,6 +115,7 @@ This folder contains detailed documentation for all process equipment in NeqSim.
105115
| Equipment | File | Description |
106116
|-----------|------|-------------|
107117
| Power Equipment | [power_generation.md](power_generation) | Gas turbines, fuel cells, renewables |
118+
| Battery Storage | [battery_storage.md](battery_storage) | Energy storage systems |
108119

109120
### Utility Equipment
110121

@@ -114,6 +125,12 @@ This folder contains detailed documentation for all process equipment in NeqSim.
114125
| Recycles | [util/recycles.md](util/recycles) | Recycle stream handling |
115126
| Calculators | [util/calculators.md](util/calculators) | Custom calculations and setters |
116127

128+
### Reliability & Failure
129+
130+
| Equipment | File | Description |
131+
|-----------|------|-------------|
132+
| Failure Modes | [failure_modes.md](failure_modes) | Equipment failure modeling for risk analysis |
133+
117134
---
118135

119136
## Quick Reference

0 commit comments

Comments
 (0)