The Pipesim Python Toolkit is a software development kit (SDK) for working with Pipesim, it uses the Python programming language, one of the most common scripting languages. The SDK provides classes and methods for working with Pipesim simulator models so that typical Pipesim tasks can be scripted and automated. It also includes integration with Microsoft Excel so that data can be shared easily between workbooks and models.
The features available through the Pipesim Python Toolkit include:
Add and delete model components.
Change and update the parameters of model components.
Convert junctions to other model components such as well and source.
Import and export wells.
Perform tasks such as network simulation, PT profile simulation and nodal analysis simulation.
Note: While the intent is for the Pipesim Python Toolkit to have the same features as the Pipesim simulator user interface, this is not yet the case. Some features may not be available and will be added in future releases.
The requirements for using the Pipesim Python Toolkit are:
Pipesim 2017.1 or later.
Python Toolkit must be installed. This option is available as part of the Pipesim installer.
Pipesim simulator base (core) system must be available.
While the Pipesim Python Toolkit includes integration with MS Excel, you do not have to have Excel installed.
You should have some knowledge of Pipesim simulator and scripting or programming.
Python is an open-source scripting language available from several different distributions and well documented both online and in literature. It has many third-party extensions, referred to as modules, which can be downloaded and installed. It is one of the top ten languages in use around the world with active development and maintenance. The open-source nature and large library of third-party extensions make it popular among the scientific community.
The Pipesim Python Toolkit includes a Python distribution from Anaconda. You must install the specific Anaconda release from SLB as included in the Pipesim simulator installer.
It is possible to have multiple installations of Python Toolkit on the same computer for different Pipesim versions.
You can manually install the file into other Python packages such as CPython.
The Python Toolkit is the equivalent to the previous Pipesim simulator OpenLink interface, which used to be part of the old versions up to 2012. It was designed and developed from the ground up as part of Pipesim simulator and is not a reimplementation of the former interface. While both aim to provide programmatic ways of interacting with Pipesim simulator, they differ substantially in their methodology. As such there is no direct comparison between their respective classes and methods, though some key points are noted below:
OpenLink uses an object orientated representation of Pipesim simulator where model components and operations are operated on. Updating a value involves manipulating the objects and their properties. Data is always passed between the model and Microsoft Excel as single values.
Pipesim Python Toolkit is an input/output (I/O) interface that sends and receives information about the model. Updating a value involves calling a function to set the component parameter to a value. Data is passed between the model and Microsoft Excel as single values and as DataFrames. The toolkit may be used independently of Microsoft Excel, for example, as scripts run from the desktop.
The Python Toolkit requires a license, but it is included free with the Pipesim simulator base (core) licenses and incurs no additional cost.
By default, Pipesim Python Toolkit installation runs for all users. But the installation package also supports a ‘Just Me’ option in the silent mode. Execute the following command in command prompt to get more details:
>>> PythonToolkitInstallTool.exe /?The software described herein is configured to operate with at least the minimum specifications set out by SLB. You are advised that such minimum specifications are merely recommendations and are not intended to be limiting to configurations that may be used to operate the software. Similarly, you are advised that the software should be operated in a secure environment, whether it is deployed across a network, on a single system, or on multiple systems. It is your responsibility to configure and maintain your network and systems in a secure manner. If you have further questions regarding recommended specifications or security, contact your local SLB representative.
You may develop your own Python code and run it on your local machine using the toolkit’s Python environment. However, as a precaution, avoid writing any distributed applications accessible to external machines, or running any Python code from unknown sources, to avoid any potential security risks.