{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Pipesim 2027.1 Python Toolkit Documentation","description":"Accelerate E&P application development and protect your innovation by consuming our Data and Domain APIs / Platform APIs.","lang":"en-US","meta":[{"name":"robots","content":"noindex"}],"llmstxt":{"hide":true,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"className":"body","role":"main"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"id":"pipesim-2027-1-python-toolkit-documentation","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"pipesim-20271-python-toolkit-documentation","__idx":0},"children":["Pipesim 2027.1 Python Toolkit Documentation"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"toctree-wrapper compound"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview","className":"reference internal"},"children":["Overview"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#functionality","className":"reference internal"},"children":["Functionality"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#prerequisites","className":"reference internal"},"children":["Prerequisites"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#python","className":"reference internal"},"children":["Python"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#upgrading-from-openlink","className":"reference internal"},"children":["Upgrading from OpenLink"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#licensing","className":"reference internal"},"children":["Licensing"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#installation-options","className":"reference internal"},"children":["Installation options"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/overview#security-notice","className":"reference internal"},"children":["Security notice"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/intro","className":"reference internal"},"children":["Introduction"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/intro#components","className":"reference internal"},"children":["Components"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/intro#model-contexts","className":"reference internal"},"children":["Model Contexts"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/intro#model-context-nuances","className":"reference internal"},"children":["Model Context Nuances"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/intro#model-components","className":"reference internal"},"children":["Model Components"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes","className":"reference internal"},"children":["Changes From Previous Version"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2026-1-to-2026-2","className":"reference internal"},"children":["Changes from 2026.1 to 2026.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2025-2-to-2026-1","className":"reference internal"},"children":["Changes from 2025.2 to 2026.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2025-1-to-2025-2","className":"reference internal"},"children":["Changes from 2025.1 to 2025.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2024-3-to-2025-1","className":"reference internal"},"children":["Changes from 2024.3 to 2025.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2024-2-to-2024-3","className":"reference internal"},"children":["Changes from 2024.2 to 2024.3"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2024-1-to-2024-2","className":"reference internal"},"children":["Changes from 2024.1 to 2024.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2023-1-to-2024-1","className":"reference internal"},"children":["Changes from 2023.1 to 2024.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2022-2-to-2023-1","className":"reference internal"},"children":["Changes from 2022.2 to 2023.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2022-1-to-2022-2","className":"reference internal"},"children":["Changes from 2022.1 to 2022.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2021-2-to-2022-1","className":"reference internal"},"children":["Changes from 2021.2 to 2022.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2021-1-to-2021-2","className":"reference internal"},"children":["Changes from 2021.1 to 2021.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2020-2-to-2021-1","className":"reference internal"},"children":["Changes from 2020.2 to 2021.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2020-1-to-2020-2","className":"reference internal"},"children":["Changes from 2020.1 to 2020.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2019-5-to-2020-1","className":"reference internal"},"children":["Changes from 2019.5 to 2020.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2019-4-to-2019-5","className":"reference internal"},"children":["Changes from 2019.4 to 2019.5"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2019-2-to-2019-3","className":"reference internal"},"children":["Changes from 2019.2 to 2019.3"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2019-1-to-2019-2","className":"reference internal"},"children":["Changes from 2019.1 to 2019.2"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2018-1-to-2019-1","className":"reference internal"},"children":["Changes from 2018.1 to 2019.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2017-2-to-2018-1","className":"reference internal"},"children":["Changes from 2017.2 to 2018.1"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/changes#changes-from-2017-1-to-2017-2","className":"reference internal"},"children":["Changes from 2017.1 to 2017.2"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart","className":"reference internal"},"children":["Quick Start"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#open-save-and-close","className":"reference internal"},"children":["Open, Save and Close"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#query-the-model","className":"reference internal"},"children":["Query the Model"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#read-and-write-parameters","className":"reference internal"},"children":["Read and Write Parameters"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#read-and-write-data-tables","className":"reference internal"},"children":["Read and Write Data Tables"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#add-and-delete","className":"reference internal"},"children":["Add and Delete"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#copy-convert-and-rename","className":"reference internal"},"children":["Copy, Convert, and Rename"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#connect-and-disconnect","className":"reference internal"},"children":["Connect and Disconnect"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#manipulate-fluids","className":"reference internal"},"children":["Manipulate Fluids"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#import-and-export-wells","className":"reference internal"},"children":["Import and Export Wells"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#catalog-and-gis","className":"reference internal"},"children":["Catalog and GIS"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#simulation-settings","className":"reference internal"},"children":["Simulation Settings"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#simulations","className":"reference internal"},"children":["Simulations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#units-of-measurement","className":"reference internal"},"children":["Units of Measurement"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#data-export","className":"reference internal"},"children":["Data Export"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#batch-update","className":"reference internal"},"children":["Batch Update"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#utility-functions","className":"reference internal"},"children":["Utility Functions"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#exploring-the-model-further","className":"reference internal"},"children":["Exploring the Model Further"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#quick-reference","className":"reference internal"},"children":["Quick Reference"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#model-class","className":"reference internal"},"children":["Model Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#about-class","className":"reference internal"},"children":["About Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#simulation-settings-class","className":"reference internal"},"children":["Simulation Settings Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#fluids-class","className":"reference internal"},"children":["Fluids Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#compositional-fluid-class","className":"reference internal"},"children":["Compositional Fluid Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#simulation-tasks-class","className":"reference internal"},"children":["Simulation Tasks Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#simulation-result-class","className":"reference internal"},"children":["Simulation Result Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#nodal-analysis-result-class","className":"reference internal"},"children":["Nodal Analysis Result Class"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#definitions-sub-module","className":"reference internal"},"children":["Definitions Sub-Module"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#important-notes","className":"reference internal"},"children":["Important Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#component-conversion","className":"reference internal"},"children":["Component Conversion"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/quickstart#component-copying","className":"reference internal"},"children":["Component Copying"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/excel","className":"reference internal"},"children":["Working with Excel"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/excel#interacting-with-excel","className":"reference internal"},"children":["Interacting with Excel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/excel#call-python-scripts-from-excel","className":"reference internal"},"children":["Call Python Scripts from Excel"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/excel#utility-functions","className":"reference internal"},"children":["Utility Functions"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/examples","className":"reference internal"},"children":["Example Code"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/examples#example-scripts","className":"reference internal"},"children":["Example Scripts"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/examples#case-studies","className":"reference internal"},"children":["Case Studies"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/troubleshooting","className":"reference internal"},"children":["Troubleshooting"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/troubleshooting#modulenotfounderror-no-module-named-module-name","className":"reference internal"},"children":["ModuleNotFoundError: No module named ‘module_name’"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/troubleshooting#no-module-named-utilities","className":"reference internal"},"children":["No module named ‘utilities’"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/troubleshooting#unable-to-import-required-dependencies","className":"reference internal"},"children":["Unable to import required dependencies"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/troubleshooting#macros-have-been-disabled","className":"reference internal"},"children":["Macros have been disabled"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/modules","className":"reference internal"},"children":["Reference Documentation"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/solutions/pipesim/sixgill","className":"reference internal"},"children":["sixgill package"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"clearer"},"children":[]}]}]},"headings":[{"value":"Pipesim 2027.1 Python Toolkit Documentation","id":"pipesim-20271-python-toolkit-documentation","depth":1}],"frontmatter":{"seo":{"title":"Pipesim 2027.1 Python Toolkit Documentation"}},"lastModified":"2026-05-13T13:46:48.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/pipesim/mainindex","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}