{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Quick Start","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":"quick-start","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"quick-start","__idx":0},"children":["Quick Start"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following section provides a quick reference guide to the properties,"," ","methods and classes available in the Pipesim Python Toolkit. Working example"," ","scripts can be found in the Pipesim installation under the Python Toolkit"," ","folder."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The easiest way to investigate a model is through an interactive Python"," ","session. Code is executed as it is entered and the results are immediately"," ","seen."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the Windows Start menu, open and start Python toolkit command prompt."," ","Type the following commands into the interactive window to see the"," ","effect of performing them."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"open-save-and-close","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"open-save-and-close","__idx":1},"children":["Open, Save and Close"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open a model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> from sixgill.pipesim import Model\n    >>> model = Model.open('C:/Temp/examples/models/CSN_301_Small Network.pips')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open a model and use the SI units of measurement for passing data:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model = Model.open(\n        filename='C:/Temp/examples/models/CSN_301_Small Network.pips',\n        units=Units.SI)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Query details about the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.about()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Close the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.close()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.save()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the model as a new filename:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.save('C:/Temp/myproject/Modified Small Network.pips')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Save the model using Network perspective:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> from sixgill.core.resources import ViewTypes\n    >>> model.save('C:/Temp/myproject/Modified Small Network.pips',ViewTypes.NETWORK)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model = Model.new('C:/Temp/myproject/New Small Network.pips')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the current model in the UI:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This will close the model in the Python Toolkit as the model cannot be edited at the same time in the Toolkit and UI."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.open_ui()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open a specific model in the UI:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> Model.open_ui('C:/Temp/myproject/New Small Network.pips')\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"query-the-model","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-the-model","__idx":2},"children":["Query the Model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Operations on the model start by providing the context for the operation. The"," ","context defines what model components are then acted on. The simplest method"," ","is find() which returns a list of the model components within the context."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List out all the components in the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(Name=ALL)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Look for all the chokes in the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> from sixgill.definitions import *\n    >>> model.find(component=ModelComponents.CHOKE)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternatively, if we already know the choke keyword:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(Choke=ALL)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find if an equipment exists by looking up its name:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(Name='PMP')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find the tubing in Well_1:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(component=ModelComponents.TUBING, Well='Well_1')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The tubing can also be referenced by its context:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(context=\"Well_1:Tubing_1\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Find the context for all the completions on all the wells:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.find(Well=ALL, component=ModelComponents.COMPLETION)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Large models can be reduced into smaller models through a filtered model"," ","which contains just those items in the context. The filtered model has all"," ","the same methods available as the full model. For example, selecting a well"," ","to perform actions on:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> wellmodel = model.filter(Well=\"Well_1\")\n    >>> wellmodel.find(component=ModelComponents.COMPLETION)\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"read-and-write-parameters","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"read-and-write-parameters","__idx":3},"children":["Read and Write Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The parameters for the model components are accessed through the get_value()"," ","and set_value() methods to read and write values respectively. There are"," ","also get_values() and set_values() methods to read and write many"," ","parameter components at the same time."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the bean size of a choke:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> from sixgill.definitions import *\n    >>> beansize = model.get_value(Name = 'Choke', parameter = Parameters.Choke.BEANSIZE)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this case the context for the choke is the same as its name, so alternatively:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_value('Choke', Parameters.Choke.BEANSIZE)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Parameters static class defines the parameters as strings. The following style can"," ","be used but it is not recommended:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_value('Well_1:VertComp', 'GeometryProfileType')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the new bean size for the choke:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(Name = 'Choke', parameter = Parameters.Choke.BEANSIZE,value = 12)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Or simply, by using the context and argument ordering:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value('Choke', Parameters.Choke.BEANSIZE, 12)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parameters can be referenced from the top level context, so long as they are unique. To"," ","set a new reservoir pressure on Well_1 with only one completion:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        Well='Well_1',\n        parameter=Parameters.Completion.RESERVOIRPRESSURE,\n        value='3210')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Which is the equivalent to:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value('Well_1:VertComp', Parameters.Completion.RESERVOIRPRESSURE, '3210')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To retrieve multiple parameters from multiple components, the get_values()"," ","method is used. For example to get specific parameters for the choke:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_values(\n        Name='Choke',\n        parameters=[Parameters.Choke.BEANSIZE,\n        Parameters.Choke.CRITICALPRESSURERATIO])\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This returns a dictionary of the components, each having a dictionary of the"," ","parameters. To retrieve the parameters from all the chokes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_values(\n        Choke=ALL,\n        parameters=[Parameters.Choke.BEANSIZE,\n        Parameters.Choke.CRITICALPRESSURERATIO])\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Passing in an empty parameter list or not passing in a list returns all the"," ","parameters for the context. To get all the parameters for all the compressors"," ","in the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> params = model.get_values(Compressor=ALL)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To update the compressors with new parameters, pass in a dictionary of the"," ","compressor parameters:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> updated_params = {'CentComp': {\n        Parameters.Compressor.HONOURSTONEWALLLIMIT: True,\n        Parameters.Compressor.ROUTE: CompressorThermodynamics.ADIABATIC,\n        Parameters.Compressor.EFFICIENCY: 100.0,\n        Parameters.Compressor.ISACTIVE: True,\n        Parameters.Compressor.PRESSUREDIFFERENTIAL: 2400.0}}\n    >>> model.set_values(updated_params)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The set_value() method sets the value for a single component and will throw"," ","an error if there is more than one component in the context. To set the same"," ","parameter value for all the items in the context, use the set_all_value()"," ","method:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_all_value(\n        Choke=ALL,\n        parameter=Parameters.Choke.BEANSIZE,\n        value=2)\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"read-and-write-data-tables","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"read-and-write-data-tables","__idx":4},"children":["Read and Write Data Tables"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parameters such as well trajectories, flowline geometries, and geothermal surveys"," ","are handled as arrays. The data is passed to and from Pipesim as pandas DataFrames"," ","so that it can be easily manipulated."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To read a flowline geometry using its context:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_geometry(context=\"F_10\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Or by passing the name as a context:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_geometry(Name=\"F_10\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The well trajectory is handled similarly as:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_trajectory(Name=\"GI_Well\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a geothermal survey:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_geothermal_profile(Name=\"F_10\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are corresponding methods for setting the data tables. The methods take"," ","the context and the DataFrame with the tabulated data. The method to set a"," ","flowline geometry is:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_geometry(context=\"F_20\", dataframe=df)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Where df is the pandas DataFrame containing the tabulated flowline profile data."," ","The DataFrame must be in the same format that the corresponding get() function uses, must have"," ","the same column headings, and must be indexed from 0."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For getting a pressure/flowrate curve on a source:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_pq_curve(Source=\"SRC1\")\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"add-and-delete","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"add-and-delete","__idx":5},"children":["Add and Delete"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Add a new source to the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(component=ModelComponents.SOURCE, name='Src1')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The parameters for the model component can be passed as an argument:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(\n        ModelComponents.CHOKE,\n        'CK1', context=\"Well 2\",\n        parameters=\n        {\n            Parameters.Choke.TOPMEASUREDDEPTH:500,\n            Parameters.Choke.BEANSIZE:2,\n            Parameters.Choke.SUBCRITICALCORRELATION:Constants.SubCriticalFlowCorrelation.ASHFORD\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For downhole equipment, pass in the context and aspects such as measured depth:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(\n        component=ModelComponents.ESP,\n        name=\"ESP1\",\n        context=\"Well 2\",\n        parameters=\n        {\n            Parameters.ESP.TOPMEASUREDDEPTH:1500,\n            Parameters.ESP.OPERATINGFREQUENCY:60,\n            Parameters.ESP.MANUFACTURER:\"ALNAS\",\n            Parameters.ESP.MODEL:\"ANA580\",\n            Parameters.ESP.NUMBERSTAGES:100,\n            Parameters.ESP.HEADFACTOR:1,\n            Parameters.ESP.POWERFACTOR:0.95,\n            Parameters.ESP.USEVISCOSITYCORRECTION:True\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For advanced well, the tubing section type can be passed as parameter:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(\n        component=ModelComponents.TUBING,\n        name=\"ShortTub\",\n        context=\"Well 2\",\n        parameters=\n        {\n            Parameters.Tubing.TOPMEASUREDDEPTH:0,\n            Parameters.Tubing.LENGTH:4000,\n            Parameters.Tubing.INNERDIAMETER:2,\n            Parameters.Tubing.ROUGHNESS:0.001,\n            Parameters.Tubing.WALLTHICKNESS:0.2,\n            Parameters.Tubing.TUBINGSECTIONTYPE: Constants.TubingSectionType.SHORTTUBING\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delete a model component:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.delete(Name='Src1')\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"copy-convert-and-rename","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"copy-convert-and-rename","__idx":6},"children":["Copy, Convert, and Rename"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Copy a well and include all the associated equipment:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.copy(context='Well_1', name='Well_2')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Convert a junction into a well:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.convert(\n        context=\"Manifold\",\n        to_component=ModelComponents.WELL)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Rename a component by setting the Name parameter:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        context=\"Src1\",\n        parameter=Parameters.Source.NAME,\n        value='SOURCE_1')\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"connect-and-disconnect","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"connect-and-disconnect","__idx":7},"children":["Connect and Disconnect"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pipesim uses ports to reference the inlet and outlet to components. To connect,"," ","specify the source (from) components, the destination (to) components, and"," ","the port to be connected where applicable."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To connect a well ‘Well_1’ to a flowline ‘FL-1’:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.connect('Well_1', 'FL-1')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Separators have two or three outlet ports hence outlet connections from a"," ","separator need to explicitly state which is used:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.connect(\n        source='MBD101',\n        destination='FL-PMP-1',\n        source_port=Connection.Separator.TOP)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Advanced well may have one, two, or three ports depending on the configuration"," ","and the port name is mandatory:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.connect(\n        source='Well_1',\n        destination='FL-2',\n        source_port=Connection.AdvancedWell.MIDDLE)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Disconnecting ports is done in the same way:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.disconnect(source='MDB101', destination='FL-PMP-1')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The model connections for a context are provided as a dictionary. This can"," ","be converted into a pandas DataFrame for convenient reviewing. Omitting the"," ","context will list all the connections in the model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.connections(context='MBD-101')\n    >>> \\#Or to see it as a nicely formatted list\n    >>> import pandas as pd\n    >>> pd.DataFrame(model.connections(context='MBD-101'))\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The get_connections() method provides a list of the connections for each"," ","item in the context. This method is easier to code in what is connected"," ","to a model component"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> mbd101_connections = model.get_connections(context=\"MBD-101\")\n    >>> mbd101_connections[Connection.SOURCE]\n    >>> mdb101_connections[Connection.Separator.TOP]\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"manipulate-fluids","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"manipulate-fluids","__idx":8},"children":["Manipulate Fluids"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Black oil and compositional fluids are treated as any other model component."," ","To select fluid type and compositional fluid details use a fluid method."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a black oil fluid:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(ModelComponents.BLACKOILFLUID, \"BK111\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the properties of the black oil fluid using, the set_value() method, for example:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.GOR,\n        value=200)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.WATERCUT,\n        value=5)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.GASSPECIFICGRAVITY,\n        value=0.7)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.WATERSPECIFICGRAVITY,\n        value=1.05)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.API,\n        value=21)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set calibration data for black oil fluid using, the set_values() method, for example:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> single_point_calibration = Parameters.BlackOilFluid.SinglePointCalibration\n    >>> model.set_values(\n        {\"BK111\": {\n        single_point_calibration.SOLUTIONGAS:\n        Constants.BlackOilCalibrationSolutionGas.VASQUEZANDBEGGS,\n        single_point_calibration.BUBBLEPOINTSATGAS_PRESSURE: 2424,\n        single_point_calibration.BUBBLEPOINTSATGAS_TEMPERATURE: 250,\n        single_point_calibration.BUBBLEPOINTSATGAS_VALUE: 202.63\n        }})\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the thermal data for black oil fluid:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.ThermalData.GASHEATCAPACITY,\n        value=0.50)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.ThermalData.OILHEATCAPACITY,\n        value=0.40)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.ThermalData.WATERHEATCAPACITY,\n        value=1.01)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.ThermalData.ENTHALPYCALCMETHOD,\n        value=EnthalpyCalcMethod.METHOD2009)\n    >>> model.set_value(\n        BlackOilFluid=\"BK111\",\n        parameter=Parameters.BlackOilFluid.ThermalData.LATENTHEATOFVAPORIZATION,\n        value=141)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the parameterization of the black oil fluid:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_values(BlackOilFluid=\"BK111\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select using compositional fluid rather than black oil:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.fluids.fluid_type = FluidType.COMPOSITIONAL\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the compositional fluid options:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> eos = Constants.EquationOfState.Multiflash.CUBICPLUSASSOCIATION\n    >>> model.fluids.compositional.pvt_package = Constants.PVTPackage.MULTIFLASH\n    >>> model.fluids.compositional.equation_of_state = eos\n    >>> model.fluids.compositional.salinity_model = Constants.SalinityModel.IONANALYSIS\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a custom pseudocomponent:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> c7plus_component_params = {\n        Parameters.FluidComponent.HYDROCARBONFORM:Constants.FluidComponentType.HYDROCARBON,\n        Parameters.FluidComponent.MOLECULARWEIGHT:234,\n        Parameters.FluidComponent.TBOIL:250,\n        }\n    >>> model.fluids.compositional.add_pseudocomponent(\n        \"C7Plus\",\n        parameters=c7plus_component_params)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Select compositional fluid components:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> selected_components = [\n        Constants.MultiflashComponent.METHANE,\n        Constants.MultiflashComponent.ETHANE,\n        Constants.MultiflashComponent.HEXANE,\n        Constants.MultiflashComponent.ETHANOL,\n        Constants.MultiflashComponent.PROPANE,\n        Constants.MultiflashComponent.WATER,\n        \"C7Plus\",\n        ]\n    >>> model.fluids.compositional.select_components(selected_components)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a compositional fluid with with salt component:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> fluid_parameters = {\n        Parameters.CompositionalFluid.LIQUIDVISCOSITYCALC:\n            Constants.EmulsionViscosityMethod.CONTINUOUSPHASE,\n        Parameters.CompositionalFluid.USERWATERCUTCUTOFF:40,\n        Parameters.CompositionalFluid.IONSODIUM:1000,\n        Parameters.CompositionalFluid.IONCALCIUM:5000,\n        Parameters.CompositionalFluid.IONMAGNESIUM:3000,\n        Parameters.CompositionalFluid.IONPOTASSIUM:4012,\n        Parameters.CompositionalFluid.IONSTRONTIUM:5000,\n        Parameters.CompositionalFluid.IONBARIUM:6000,\n        Parameters.CompositionalFluid.IONIRON:17000,\n        Parameters.CompositionalFluid.IONCHLORIDE:1000,\n        Parameters.CompositionalFluid.IONSULPHATE:1235,\n        Parameters.CompositionalFluid.IONBICARBONATE:11122,\n        Parameters.CompositionalFluid.IONBROMIDE:544,\n        Parameters.CompositionalFluid.IONBARIUM:5555,\n        Parameters.CompositionalFluid.SALTWATERDENSITYTYPE:\n            Constants.SaltWaterDensity.DENSITY,\n        Parameters.CompositionalFluid.SALTWATERDENSITY:72,\n        }\n"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.add(ModelComponents.COMPOSITIONALFLUID, \"Comp1\", parameters=fluid_parameters)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The compositional fluid is read through the method on the fluids:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.fluids.compositional.get_composition(\"Comp1\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["And the corresponding method for setting the composition:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.fluids.compositional.set_composition(df)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Assign a black oil fluid to a well:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        Well = \"Well 2\",\n        parameter=Parameters.Well.ASSOCIATEDBLACKOILFLUID,\n        value=\"BK111\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Assign a compositional fluid to a well:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(\n        Well = \"Well 2\",\n        parameter=Parameters.Well.ASSOCIATEDCOMPOSITIONALFLUID,\n        value=\"COMP1\")\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"import-and-export-wells","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"import-and-export-wells","__idx":9},"children":["Import and Export Wells"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can import and export Wells to/from individual Pipesim models. To export"," ","a well to a Pipesim model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.export_well(context=\"Well_1\",\n        folder=\"C:/temp/myproject/wells\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To export all the wells, leave out the context:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.export_well(folder=\"C:/temp/myproject/wells\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the folder is not provided then it will export to the same folder as the"," ","currently open Pipesim model."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Import a Pipesim well model into the currently open model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.import_well(filename=\"C:/temp/myproject/Well.pips\", name=\"Well_1\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the fluid from the imported model:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.import_well(\n        filename=\"C:/temp/myproject/Well.pips\",\n        name=\"Well_1\",\n        fluid_override=False)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To overwrite the existing “Well_1” in the current model with the imported well:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.import_well(\n        filename=\"C:/temp/myproject/Well.pips\",\n        name=\"Well_1\",\n        overwrite_existing=True)\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"catalog-and-gis","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"catalog-and-gis","__idx":10},"children":["Catalog and GIS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the elevation for a coordinate (latitude, longitude):"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_elevation(lat=44.4532, long=76.16231)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get elevations for multiple coordinates:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.get_elevations(\n                [{Parameters.Location.LATITUDE:44.4532,Parameters.Location.LONGITUDE:76.16231},\n                {Parameters.Location.LATITUDE:45.5532,Parameters.Location.LONGITUDE: 78.6678}])\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Reading entries from the catalog. Parameters required for the look-up, such"," ","as manufacturer and series, must have been set on the component first:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.read_catalog(\"PCP\")\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"simulation-settings","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulation-settings","__idx":11},"children":["Simulation Settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can operate on the simulation settings through both a dictionary and"," ","individual properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the current simulation settings as a dictionary:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the ambient temperature:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.ambient_temperature\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set the ambient temperature:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.ambient_temperature = 70\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternatively, using the dictionary syntax:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings[Parameters.SimulationSetting.AMBIENTTEMPERATURE] = 70\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The global flow correlations are provided as a dictionary by:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.global_flow_correlation()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["And to set the global flow correlations, pass back in a dictionary:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> multiphase = Parameters.FlowCorrelation.Multiphase\n    >>> model.sim_settings.global_flow_correlation({\n        multiphase.Vertical.CORRELATION:\n            Constants.MultiphaseFlowCorrelation.BakerJardine.BEGGSBRILLORIGINAL,\n        multiphase.Horizontal.CORRELATION:\n            Constants.MultiphaseFlowCorrelation.BakerJardine.BEGGSBRILLORIGINAL\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To use the local flow correlations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.use_global_flow_correlation = False\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The local flowline correlations are accessed through context based get/set"," ","methods."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.get_flow_correlations(Flowline=ALL)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the context is left empty then it returns all the flowline and"," ","well trajectories that be specified:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.get_flow_correlations()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To set the flow correlations for a flowline, pass in the dictionary of"," ","parameters for the flowlines or wells to be set:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> multiphase = Parameters.FlowCorrelation.Multiphase\n    >>> model.sim_settings.set_flow_correlations({\n        \"FL_10\": {\n            Parameters.FlowCorrelation.OVERRIDEGLOBAL: True,\n            multiphase.Vertical.CORRELATION:\n                Constants.MultiphaseFlowCorrelation.BakerJardine.BEGGSBRILL,\n            multiphase.Horizontal.CORRELATION:\n                Constants.MultiphaseFlowCorrelation.BakerJardine.BEGGSBRILL\n        }})\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The heat transfer options use the same methodology. To get the global heat"," ","transfer options:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.global_heat_transfer_option()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To set the heat transfer options:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.global_heat_transfer_option({\n    Parameters.HeatTransferOption.PIPEBURIALMETHOD: Constants.PipeBurialMethod.METHOD2009})\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get and set the local heat transfer options:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.sim_settings.get_heat_transfer_options(Flowline=ALL)\n    >>> model.sim_settings.set_heat_transfer_options({\n        \"FL_10\": {\n        Parameters.HeatTransferOption.OVERRIDEGLOBAL: True,\n        Parameters.HeatTransferOption.PIPEBURIALMETHOD: Constants.PipeBurialMethod.METHOD2009\n        }})\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list of available simulation setting properties is provided in the"," ","Quick Reference section below."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"simulations","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulations","__idx":12},"children":["Simulations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Simulations are performed through the tasks class. Each task has the same"," ","core methods available, with additional methods depending on the task being"," ","performed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the current boundary conditions for a network simulation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.get_conditions()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a specific study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.get_conditions(study=\"Late Field Life\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update the boundary conditions for the default network simulation study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> boundaries =\n        {\"Well:VertComp\":\n            {\n                Parameters.Boundary.PRESSURE:NAN,\n                Parameters.Boundary.TEMPERATURE:150,\n                Parameters.Boundary.FLOWRATETYPE:Constants.FlowRateType.LIQUIDFLOWRATE,\n                Parameters.Boundary.LIQUIDFLOWRATE:200\n            }\n        }\n    >>> model.tasks.networksimulation.set_conditions(boundaries = boundaries)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To reset the boundary conditions to those of the model for the default study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.reset_conditions()\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The simulation performance is directly affected by the number of specified system and profile variables in a simulation task."," ","If omitted, then all the possible system and profile variables are returned, which will significantly jeopardize the simulation performance."," ","To produce all results available in a UI simulation run, the predefined output variables available in the UI can be selected."," ","These predefined output variables include large lists of variables. For the best simulation performance, only the required output variables are specified."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To run the network simulation study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> system_variables = [\n        SystemVariables.PRESSURE,\n        SystemVariables.TEMPERATURE,\n        SystemVariables.VOLUME_FLOWRATE_LIQUID_STOCKTANK,\n        SystemVariables.VOLUME_FLOWRATE_OIL_STOCKTANK,\n        SystemVariables.VOLUME_FLOWRATE_WATER_STOCKTANK,\n        SystemVariables.VOLUME_FLOWRATE_GAS_STOCKTANK,\n        SystemVariables.BOTTOM_HOLE_PRESSURE,\n        SystemVariables.OUTLET_GLR_STOCKTANK,\n        SystemVariables.OUTLET_WATER_CUT_STOCKTANK,\n        ]\n    >>> profile_variables = [\n        ProfileVariables.TEMPERATURE,\n        ProfileVariables.ELEVATION,\n        ProfileVariables.TOTAL_DISTANCE,\n        ]\n    >>> results = model.tasks.networksimulation.run(\n        system_variables=system_variables,\n        profile_variables=profile_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The study conditions can be passed into the run_simulation() method. This"," ","allows simulations to be queued up, each with their own study conditions:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> results = model.tasks.networksimulation.run(\n        boundaries=boundaries,\n        system_variables=system_variables, profile_variables=profile_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Predefined results variable lists are available as available in the Pipesim UI:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> results = model.tasks.networksimulation.run(\n        boundaries=boundaries,\n        system_variables=OutputVariables.System.FLOW_ASSURANCE,\n        profile_variables=OutputVariables.Profile.FLOW_ASSURANCE)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The simulation results is an object with three properties: system, node and profile. For"," ","network simulations, the node and system results are dictionaries of each node"," ","or system point respectively while the profile is a dictionary of each branch."," ","In a PT Profile simulation the system points is also a dictionary of the sensitivities."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The node results for a network simulation as a dataframe:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> pd.DataFrame(results.node)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The system results for a network simulation as a dataframe"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> pd.DataFrame(results.system)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The profile results for flowline FL-45 in a network simulation as a DataFrame:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> pd.DataFrame(results.profile[\"FL-45\"])\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The run() method executes concurrently and the results are returned when it finishes."," ","To run the simulation in the background, use the start_simulation() method. This"," ","allows the Python script to continue executing while the simulation is running:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> simulation_id = model.tasks.networksimulation.start(\n            profile_variables=profile_variables,\n            system_variables=system_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this case, the status of the simulation is returned by:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.get_state(simulation_id)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["And when finished, the simulation message and results are retrieved:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> message = model.tasks.networksimulation.get_messages(simulation_id)\n    >>> results = model.tasks.networksimulation.get_results(simulation_id)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that the simulations using start() are queued by the Pipesim engine"," ","and are run concurrently. The simulations are not run in parallel, only"," ","that the Python script can continue running while each simulation finishes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["PT Profile simulations are performed in the same manner. The arguments passed"," ","to the study and simulation methods are accordingly different:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> parameters = {\n            Parameters.PTProfileSimulation.INLETPRESSURE:2600,  #psia\n            Parameters.PTProfileSimulation.OUTLETPRESSURE:200,  #psia\n            Parameters.PTProfileSimulation.LIQUIDFLOWRATE:3000,  #stb/d\n            Parameters.PTProfileSimulation.FLOWRATETYPE:Constants.FlowRateType.LIQUIDFLOWRATE,\n            Parameters.PTProfileSimulation.CALCULATEDVARIABLE:Constants.CalculatedVariable.CUSTOM,\n            Parameters.PTProfileSimulation.CUSTOMVARIABLE: {\n                Parameters.PTProfileSimulation.CustomVariable.COMPONENT:\"FL-1\",\n                Parameters.PTProfileSimulation.CustomVariable.VARIABLE:\"InnerDiameter\",\n                Parameters.PTProfileSimulation.CustomVariable.MINVALUE:1,\n                Parameters.PTProfileSimulation.CustomVariable.MAXVALUE:10,\n                }\n            }\n    >>> results = model.tasks.ptprofilesimulation.run(\n            producer=\"Well\",\n            parameters=parameters,\n            profile_variables=profile_variables,\n            system_variables=system_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a PT Profile sensitivity study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> parameters = {\n            Parameters.PTProfileSimulation.INLETPRESSURE:2600,  #psia\n            Parameters.PTProfileSimulation.OUTLETPRESSURE:200,  #psia\n            Parameters.PTProfileSimulation.CALCULATEDVARIABLE:Constants.CalculatedVariable.FLOWRATE,\n            Parameters.PTProfileSimulation.FLOWRATETYPE:Constants.FlowRateType.LIQUIDFLOWRATE,\n            Parameters.SingleBranchSimulation.SENSITIVITYVARIABLE: {\n                Parameters.SingleBranchSimulation.SensitivityVariable.COMPONENT: \"VertComp\",\n                Parameters.SingleBranchSimulation.SensitivityVariable.VARIABLE:\n                    Parameters.Completion.RESERVOIRPRESSURE,\n                Parameters.SingleBranchSimulation.SensitivityVariable.VALUES: [2000, 3000, 4000]\n                }\n            }\n    >>> results = model.tasks.ptprofilesimulation.run(\n        producer=\"Well\",\n        parameters=parameters,\n        system_variables=system_variables,\n        profile_variables=profile_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If Component is a OneSubsea wet gas compressor and Variable is PressureRatio"," ","or Speed, ApplyAll can be set to true such that the sensitivity values are"," ","applied to all OneSubsea wet gas compressors in that branch:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> parameters = {\n            Parameters.PTProfileSimulation.INLETPRESSURE:2600,  #psia\n            Parameters.PTProfileSimulation.OUTLETPRESSURE:200,  #psia\n            Parameters.PTProfileSimulation.CALCULATEDVARIABLE:Constants.CalculatedVariable.FLOWRATE,\n            Parameters.PTProfileSimulation.FLOWRATETYPE:Constants.FlowRateType.LIQUIDFLOWRATE,\n            Parameters.SingleBranchSimulation.SENSITIVITYVARIABLE: {\n                Parameters.SingleBranchSimulation.SensitivityVariable.COMPONENT: \"WetGasCompressor\",\n                Parameters.SingleBranchSimulation.SensitivityVariable.VARIABLE:\n                    Parameters.Compressor.PRESSURERATIO,\n                Parameters.SingleBranchSimulation.SensitivityVariable.VALUES: [1.2, 1.3, 1.4],\n                Parameters.SingleBranchSimulation.SensitivityVariable.APPLYALL: True\n                }\n            }\n    >>> results = model.tasks.ptprofilesimulation.run(\n        producer=\"Well\",\n        parameters=parameters,\n        system_variables=system_variables,\n        profile_variables=profile_variables)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["With a PT Profile simulation, the list of available components and variables"," ","for a producer is found from:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.ptprofilesimulation.get_sensitivity_variables(\"Well_1\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Nodal analysis simulation is supported in a similar manner."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get current nodal analysis parameters and inlet conditions for a specified"," ","producer and study:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> general_conds,inlet_conds = model.tasks.nodalanalysis.get_conditions(\n            producer=\"Well\", study='Study1')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A nodal point can be applied to a nodal analysis simulation when getting the"," ","parameters of a nodal analysis study."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For surface nodal point:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> na_sim, inlet_conds = model.tasks.nodalanalysis.get_conditions(\n            \"Well 1\",\n            nodal_point_settings = {\n            Parameters.NodalPoint.NODALTYPE: Constants.NodalPointType.SURFACE,\n            Parameters.NodalPoint.EQUIPMENT: 'Choke',\n            Parameters.NodalPoint.NAME: 'NA1'\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For downhole nodal point:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> na_sim, inlet_conds = model.tasks.nodalanalysis.get_conditions(\n            \"Well 1\", \"Study 2\",\n            nodal_point_settings = {\n            Parameters.NodalPoint.NODALTYPE: Constants.NodalPointType.DOWNHOLE,\n            Parameters.NodalPoint.DEPTH: 1000,\n            Parameters.NodalPoint.WELLSTRINGTYPE: Constants.TubingSectionType.TUBING,\n            Parameters.NodalPoint.NAME: 'NA2'\n        })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update the general and inlet conditions as well as nodal point settings for"," ","a nodal analysis simulation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.nodalanalysis.set_conditions(\n            \"Well 1\",\n            parameters={\n                Parameters.NodalAnalysisSimulation.LIMITINFLOW: True,\n                Parameters.NodalAnalysisSimulation.LIMITOUTFLOW: False,\n                Parameters.NodalAnalysisSimulation.OUTFLOWPOINTS: 40,\n                Parameters.NodalAnalysisSimulation.INFLOWPOINTS: 50,\n                Parameters.NodalAnalysisSimulation.MAXFLOWRATETYPE:\n                    Constants.FlowRateType.GASFLOWRATE,\n                Parameters.NodalAnalysisSimulation.OUTLETPRESSURE: 3000,\n                Parameters.NodalAnalysisSimulation.MAXGASRATE: 300,\n                Parameters.NodalAnalysisSimulation.MAXOUTFLOWPRESSURE: 400,\n                Parameters.NodalAnalysisSimulation.BRANCHTERMINATOR: \"Choke\"\n            },\n            inlet_conditions={\n            \"Well 1:Comp1\":{ Parameters.Boundary.PRESSURE:4000,\n                             Parameters.Boundary.TEMPERATURE:200\n                            }\n            },\n            nodal_point_settings={\n                Parameters.NodalPoint.NODALTYPE: Constants.NodalPointType.DOWNHOLE,\n                Parameters.NodalPoint.DEPTH: 1000,\n                Parameters.NodalPoint.WELLSTRINGTYPE: Constants.TubingSectionType.TUBING,\n                Parameters.NodalPoint.NAME: 'NA2'\n            })\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Run simulation and get results:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> sim_results = model.tasks.nodalanalysis.run( \"Well 1\",\n        parameters={\n            Parameters.NodalAnalysisSimulation.OUTLETPRESSURE: 3000,\n            Parameters.NodalAnalysisSimulation.BRANCHTERMINATOR: \"Choke\"\n        },\n        nodal_point_settings = {\n            Parameters.NodalPoint.NODALTYPE: Constants.NodalPointType.SURFACE,\n            Parameters.NodalPoint.EQUIPMENT: 'Choke',\n            Parameters.NodalPoint.NAME: 'NA4'\n        },\n        profile_variables=OutputVariables.Profile.GAS_FIELD,\n        system_variables=OutputVariables.System.GAS_FIELD)\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Note that system variables that are related to nodal analysis simulation"," ","are generated in results by default no matter whether they are provided in"," ","system_variables or not."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Additional information speical to nodal analysis simulation such as"," ","inflow curves, outflow curves, operating points, operating envelope"," ","and fuild base can also be obtained from the results."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the information of inflow curve in the first case:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> result.inflow_curves[0].case\n    >>> curve = result.inflow_curves[0].curve_data\n    >>> liquid_curve = curve[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_LIQUID_STOCKTANK]\n    >>> mass_curve = curve[SystemVariables.NODAL_POINT_MASS_FLOWRATE_FLUID]\n    >>> gas_curve = curve[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_GAS_STOCKTANK]\n    >>> presure_curve = curve[SystemVariables.NODAL_POINT_PRESSURE]\n    >>> units = result.inflow_curves[0].units\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the operating envelope for gas phase. Note that operating envelope is"," ","generated when there is only one case in simulaiton results."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> max_drawdown = result.operating_envelope.max_drawdown\n    >>> max_drawdown[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> max_drawdown[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n    >>> res_pres = result.operating_envelope.reservoir_pressure\n    >>> res_pres[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> res_pres[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n    >>> ero_velocity = result.operating_envelope.erosional_velocity\n    >>> ero_velocity[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> ero_velocity[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n    >>> aofp = result.operating_envelope.aofp\n    >>> aofp[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> aofp[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n    >>> inversion_point = result.operating_envelope.inversion_point\n    >>> inversion_point[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> inversion_point[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n    >>> liquid_loading = result.operating_envelope.liquid_loading\n    >>> liquid_loading[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATE]\n    >>> liquid_loading[Parameters.NodalOperatingEnvelopePlot.GASFLOWRATEPRESSURE]\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the operating point data for each phase and units in the first case:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> point = result.operating_points[0].point_data\n    >>> point[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_LIQUID_STOCKTANK]\n    >>> point[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_GAS_STOCKTANK]\n    >>> point[SystemVariables.NODAL_POINT_MASS_FLOWRATE_FLUID]\n    >>> point[SystemVariables.NODAL_POINT_PRESSURE]\n    >>> units = result.operating_points[0].units\n    >>> units[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_LIQUID_STOCKTANK]\n    >>> units[SystemVariables.NODAL_POINT_VOLUME_FLOWRATE_GAS_STOCKTANK]\n    >>> units[SystemVariables.NODAL_POINT_MASS_FLOWRATE_FLUID]\n    >>> units[SystemVariables.NODAL_POINT_PRESSURE]\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the fluid base for nodal analysis operation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> fluid_base = result.fluid_base\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The console messages, summary and state of the simulation after it has"," ","finished are properties on the results. This include errors and warnings"," ","that you would ordinarily see in the Pipesim console."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To get the final state of the simulation:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> results.state\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A summary of the messages as reported in the Pipesim UI:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> results.summary\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The full console messages as reported by the Pipesim engine:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> results.messages\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Generate Pipesim engine files in the current folder:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.generate_engine_files(study=\"Study 1\")\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To specify the folder for the engine files:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.ptprofilesimulation.generate_engine_files(\n        study=\"Study 1\",\n        folder='c:/temp/myproject')\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The method returns the list of files that has been generated."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"units-of-measurement","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"units-of-measurement","__idx":13},"children":["Units of Measurement"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the engineering unit and the symbol for a parameter:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.describe(context=\"Choke\", parameter=Parameters.Choke.BEANSIZE).units\n    >>> model.describe(context=\"Choke\", parameter=Parameters.Choke.BEANSIZE).units_symbol\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get the engineering unit conversion for a parameter:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.describe(context=\"Choke\", parameter=Parameters.Choke.BEANSIZE).si_scale\n    >>> model.describe(context=\"Choke\", parameter=Parameters.Choke.BEANSIZE).si_offset\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"data-export","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"data-export","__idx":14},"children":["Data Export"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The model parameters can be exported to a csv file. Note that this does not"," ","include the tabulated data such as trajectories at this time:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.export_parameters(filename=\"C:/Temp/myproject/ExportedParams.csv\")\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"batch-update","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"batch-update","__idx":15},"children":["Batch Update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Operations such as get/set are performed immediately and independently"," ","on the model. Each command must finish before the next one can start. There"," ","is an overhead on performing each operation through the underlying web API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The batch update method caches the operations and perform them as a"," ","single operation on the web API. This provides improved performance over"," ","doing individual operations."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The syntax for using the batch operation is:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> with model.batch_update():\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.GOR,\n                value=200)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.WATERCUT,\n                value=5)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.GASSPECIFICGRAVITY,\n                value=0.7)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.WATERSPECIFICGRAVITY,\n                value=1.05)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.API,\n                value=21)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.FRACTIONCO2,\n                value=0.05)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.FRACTIONH2S,\n                value=0.001)\n            model.set_value(\n                BlackOilFluid=\"BK111\",\n                parameter=Parameters.BlackOilFluid.FRACTIONN2,\n                value=0.1)\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"utility-functions","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"utility-functions","__idx":16},"children":["Utility Functions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following utility functions are included in the Pipesim Python Toolkit."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["active_sheet()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the current active Excel sheet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clear_contents()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Clean contents of specified collection(range or sheet)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["convert_tubing_bmd()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Convert bottom measured depth to top measured depth and length."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["current_folder()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the folder (path) for the Excel workbook."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_refers_to_range()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return refers_to_range from specified range name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_model_session()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the active model session that the workbook is connected to."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["range_to_dataframe()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Convert an Excel range which is a list of lists to a panda DataFrame."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["range_to_dictionary()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Convert an Excel range which is a list of lists to a dictionary of dictionaries."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["worksheet_last_column()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the last column with the data specified on the specified worksheet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["worksheet_last_row()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the row column with the data specified on the specified worksheet."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"convert-bottom-measured-depth","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"convert-bottom-measured-depth","__idx":17},"children":["Convert Bottom Measured Depth"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Pipesim data model uses top measured depth (TMD) and length as the"," ","parameters for tubing, casing and liners. Data is often provided, however,"," ","as bottom measured depth (BMD). The method converts a list of BMD to"," ","a dictionary of TMD and length for setting as parameters."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> from sixgill.utilities import convert_tubing_bmd\n    >>> tmd_param = convert_tubing_bmd([2000.0, 2400.0, 2800.0, 3500.0])\n    >>> model.add(ModelComponents.CASING, \"Csg1\", context=\"Well1\", parameters=tmd_param[0])\n    >>> model.add(ModelComponents.TUBING, \"Tb1\", context=\"Well1\", parameters=tmd_param[1])\n"},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"exploring-the-model-further","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"exploring-the-model-further","__idx":18},"children":["Exploring the Model Further"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Python Toolkit provides complete access to the underlying data model"," ","through the function calls. In many areas there are several ways to access"," ","the same data."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For instance, to use the surface conditions of a well for the boundaries:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.tasks.networksimulation.use_surface_conditions = True\n"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is also available through:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"doctest highlight-default notranslate"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"    >>> model.set_value(component=ModelComponents.NETWORKSIMULATION,\n            Study='Study 1',\n            parameter=Parameters.NetworkSimulation.USESURFACEBOUNDARYCONDITIONS,\n            value = True)\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"quick-reference","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"quick-reference","__idx":19},"children":["Quick Reference"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"model-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"model-class","__idx":20},"children":["Model Class"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"properties","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties","__idx":21},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["about"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ModelAbout. The model information (see About class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["api"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PipesimSession. The web API object connected to Pipesim"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["context"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["AbstractModelContext. The full (root) context of the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["is_open"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Whether the model is open (True) or not (False)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filename"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The full path and filename of the model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fluids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fluid settings (see Fluids class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["session"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PipesimSession. The current session."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sim_settings"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Model settings (see Simulation Settings class)."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"methods","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods","__idx":22},"children":["Methods"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["about()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Return the details about the model and Pipesim version"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["add()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add a component to the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["batch_update()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cache the model updates and apply as a single operation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["close()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Close the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["connect()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connect two model components"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["connections()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List the connections in the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["convert()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Convert a component to a different type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["copy()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Copy a model component"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a component from the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_coating()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the pipe coating table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_deadoil_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the dead oil user defined viscosity table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_mix_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the emulsion viscosity user defined table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_relative_permeability_data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete relative permeability data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_simulation()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the simulation results"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["describe()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the details of a parameter, such as units of measurement"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["disconnect()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Disconnect two model components"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["export_well()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export a well to a Pipesim model file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["export_parameters()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Export the model parameters to a csv file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filter()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter the model for a specific context"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["find()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Find components in the model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["find_components()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Find the full context of the specified component"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["find_component_object()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Find the model components in the context"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_coating()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the pipe coating table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_connections()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the connections for each item in the context"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_completion_ipr_points()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Pwf and Rate values for the IPR model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_completion_test_points()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the completion test points"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_deadoil_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the dead oil user defined viscosity table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_elevation()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the elevation for a latitude / longitude location"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_elevations()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get elevations for multiple latitude / longitude locations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_geometry()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the flowline geometry"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_geothermal_profile()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the geothermal profile"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_mix_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the emulsion viscosity user defined table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_pq_curve()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the well performance curve"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_relative_permeability_data()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get relative permeability data from Darcy IPR model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_trajectory()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the well trajectory"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_value()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a parameter from a model component"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_values()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get parameters from model components"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["import_well()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import a well from a Pipesim model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["import_wells()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import all wells from a specified folder"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["new()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and open a new Pipesim model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["open()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Open a Pipesim model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["open_ui()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Open a Pipesim model in the Pipesim UI"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["read_catalog()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update the component parameters from the catalog"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["save()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Save the Pipesim model"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_all_value()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the parameter for all the model components"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_coating()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the pipe coating table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_completion_test_points()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the completion test points table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_deadoil_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the dead oil user defined viscosity table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_geometry()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the flowline geometry"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_geothermal_profile()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the geothermal profile"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_mix_viscosity_table()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the emulsion viscosity user defined table"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_pq_curve()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the well performance curve"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_relative_permeability_data()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set relative permeability data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_trajectory()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the well trajectory"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_value()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set a parameter on a model component"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_values()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set a series of parameters on one or more model components"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["sim_settings()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the simulation settings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["update_data_context()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Updates the model with the latest production data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["validate()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Validates the model or a specified well, task"]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"about-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"about-class","__idx":23},"children":["About Class"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The properties and methods are accessed by prefixing with ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["model"]},".about."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id1","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-1","__idx":24},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filename"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The filename of the model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unit_system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The units of measurement system."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ui_unit_system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The display units of measurement system in UI."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["toolkit_version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The release number of the Pipesim Python Toolkit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["webapi_version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The Pipesim Web API release number"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id2","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-1","__idx":25},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no methods on the About() class."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"simulation-settings-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulation-settings-class","__idx":26},"children":["Simulation Settings Class"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id3","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-2","__idx":27},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ambient_temperature"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The ambient temperature"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["atmospheric_pressure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The atmostpheric pressure."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["corrosion_efficiency"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The corrosion efficiency"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["corrosion_limits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ErosionCorrosionRiskIndexLimits. Corrosion risk limits."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["corrosion_model"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The corrosion model (CorrosionModel static class)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["corrosion_model_dewaard"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DewaardCorrosionModel. The deWaard corrosion model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["corrosion_model_tpa"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TpaCorrosionModel. The TPA corrosion model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["erosion_limits"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ErosionCorrosionRiskIndexLimits. Erosion risk limits."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["erosional_velocity_constant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The erosional velocity constant."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["gis_elevation_data_source"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. GIS elevation data source (GISDataSource static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["gis_elevation_interval"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. GIS elevation interval."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["gis_elevation_max_points"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer. GIS elevation maximum number of points."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["global_flow_correlations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. The global flow correlation settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["global_heat_transfer_options"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. The global heat transfer settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["max_computation_segment_length"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The maximum computational segment length for pipe segmentation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["max_report_interval_length"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The maximum report interval length for pipe segmentation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["metocean_data_location"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The Metocean data location. (MetoceanDataLocation static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network_solver_max_iterations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer. The network solver maximum number of iterations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network_solver_method"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The network solver method (NetworkSolverMethod static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network_solver_tolerance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The network solver tolerance."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network_keywords_bottom"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Network engine bottom keywords."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["network_keywords_top"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Network engine top keywords."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["print_computation_segment_result"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Print the computational segment result for pipe segmentation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["single_branch_keywords"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Single branch engine keywords."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["soil_conductivity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The soil conductivity"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["soil_type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The soil type (SoilType static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["use_global_corrosion_model"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Use the global corrosion model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["use_global_flow_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Use the global flow correlations."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["use_global_heat_transfer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean. Use the global heat transfer settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wind_speed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Float. The wind speed."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id4","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-2","__idx":28},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no methods on the SimulationSettings() class. The ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["model"]},".sim_settings()"," ","can return a dictionary, or be treated as a dictionary. See the examples under"," ","the Quick Start section."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_corrosion_models()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get corrosion model settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_flow_correlations()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get flow correlation settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_heat_transfer_options()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get heat transfer options."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_corrosion_models()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set corrosion model settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_flow_correlations()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set flow correlation settings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_heat_transfer_options()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set heat transfer options."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"fluids-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"fluids-class","__idx":29},"children":["Fluids Class"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The properties and methods are accessed by prefixing with ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["model"]},".fluids."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id5","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-3","__idx":30},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fluid_type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of fluid used (FluidType static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["compositional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The compositional fluid settings (see Compositional fluid class)."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id6","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-3","__idx":31},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no methods on the fluids class."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"compositional-fluid-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"compositional-fluid-class","__idx":32},"children":["Compositional Fluid Class"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The properties and methods are accessed by prefixing with ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["model"]},".fluids.compositional"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id7","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-4","__idx":33},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["acf_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. ACF Correlation (ACFCorrelationMethod static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["critical_property_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Critical Property Correlation (CriticalPropertyCorrelationMethod class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["equation_of_state"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Equation of state (EquationOfState static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pvt_package"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. PVT Package (PVTPackage static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["salinity_model"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Salinity model (SalinityModel static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["thermal_coefficient_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Thermal Coefficient Correlation (ThermalCoefficientCorrelationMethod class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["viscosity_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Viscosity correlation (ViscosityCorrelationMethod static class)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["volume_shift_correlation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. Volume shift correlation (VolumeShiftCorrelationMethod static class)."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id8","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-4","__idx":34},"children":["Methods"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["add_pseudocomponent()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add a pseudocomponent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_pseudocomponent()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a pseudocomponent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_composition()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get fluid composition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["select_components()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Select components for the compositional fluid."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_composition()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set fluid composition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["unselect_components()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unselect components for the compositional fluid."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"simulation-tasks-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulation-tasks-class","__idx":35},"children":["Simulation Tasks Class"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The properties and methods are accessed by prefixing with ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["model"]},".tasks. There is"," ","a class for each of the supported tasks."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"classes","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"classes","__idx":36},"children":["Classes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Class"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["networksimulation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running network simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["networkoptimizersimulation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running network optimization studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ptprofilesimulation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running PT profile simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["nodalanalysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running nodal analysis simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["systemanalysis"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running system analysis simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wellperformancecurves"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running well performance curves simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["gldiagnostics"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running gas lift diagnostics simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["systemperformance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running system performance simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["vpftablessimulation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running VFP tables simulation studies."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["wellcalibration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Methods for running well calibration studies."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id9","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-5","__idx":37},"children":["Methods"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Methods"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_constraints()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the rate constraints of the network simulation task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete_results()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete the simulation results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["generate_engine_files()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generate the engine files for a study"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_calculated_variables()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PT Profile. Get the available calculated variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_conditions()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the study boundary conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_constraints()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the rate constraints of the network simulation task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_messages()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the simulation messages of the simulation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_results()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the simulation results."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_sensitivity_variables()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PT Profile. Get the available sensitivity variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_state()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get the running state of the simulation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get_use_surface_conditions()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get whether the model is using surface conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["reset_conditions()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reset the study boundary / inlet conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["run()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run a simulation task and wait for it to finish."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_conditions()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the study boundary conditions or general conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_constraints()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set the rate constraints to the network simulation task."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["set_use_surface_conditions()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set whether the model is using surface conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["start()"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start a simulation task."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"simulation-result-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"simulation-result-class","__idx":38},"children":["Simulation Result Class"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id10","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-5","__idx":39},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["system"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. System results of a simulation run. ."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["node"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. Node results of a simulation run."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["profile"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. Profile results of a sumulation run."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["profile_units"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. Profile variables and units mapping."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["cases"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of sensitivity cases for a single branch simulation run."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["messages"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of engine console messages from a simulation run."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["summary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. A summary of a simulation run status, including errors and warnings."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["state"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The state of a simulation run: RUNNING, COMPLETED, FAILED."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["esp_curves"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dictionary. ESP curves."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id11","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-6","__idx":40},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no methods on the SimulationResult() class."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"nodal-analysis-result-class","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"nodal-analysis-result-class","__idx":41},"children":["Nodal Analysis Result Class"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A subclass of Simulation Result class containing data for Nodal Plot."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id12","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"properties-6","__idx":42},"children":["Properties"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Property"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["inflow_curves"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of inflow curves, one per each inflow case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["outflow_curves"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of outflow curves, one per each outflow case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operating_points"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of operation points, one per each sensitivity case."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["inflow_cases"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of inflow case names."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["outflow_cases"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List. A list of outflow case names."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["fluid_base"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String. The fluid base of nodal simulation results: GAS, LIQUID, or MASS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["operating_envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operating envelope of nodal analysis simulation."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"id13","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"methods-7","__idx":43},"children":["Methods"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There are no methods on the NodalAnalysisResult() class."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"definitions-sub-module","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"definitions-sub-module","__idx":44},"children":["Definitions Sub-Module"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The definitions sub-module within Sixgill provides static classes for the model"," ","operations and parameterization. The enumerations of parameters such as"," ","EmulsionViscosityMethod.CONTINUOUSPHASE translating to ‘ContinuousPhase’ is"," ","provided for autocompletion and code editing IntelliSense."]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"static-classes","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"static-classes","__idx":45},"children":["Static Classes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Static Class"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Connection"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Model component connection ports."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Constants"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String enumerations used by the Pipesim data model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ModelComponents"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Model components."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OutputVariables"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Predefined groups of output variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parameters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parameters for each model component."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ProfileVariables"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Output profile variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SimulationState"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Simulation states."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SystemVariables"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Output system variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tasks"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Tasks that can be performed on the model."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Units"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Available unit systems when opening a model."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"special-keywords","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"special-keywords","__idx":46},"children":["Special Keywords"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following special string definitions are provided as global variables:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Global Variable"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["NAN"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mathematical operator “Not a Number” (NaN)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ALL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Match all the items in the context."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["NONE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Match none of the items in the context."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["TEMPLATE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Match template items in the context."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GLOBAL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The global setting (heat transfer and flow correlations)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DEFAULT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The default setting (heat transfer and flow correlations)."]}]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"important-notes","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"important-notes","__idx":47},"children":["Important Notes"]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"component-conversion","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"component-conversion","__idx":48},"children":["Component Conversion"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Python Toolkit only supports converting junctions, which can only be"," ","converted to a Well, Source or Sink."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"id":"component-copying","className":"section"},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"component-copying","__idx":49},"children":["Component Copying"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The copy() method only works on wells at this time."]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"clearer"},"children":[]}]}]},"headings":[{"value":"Quick Start","id":"quick-start","depth":1},{"value":"Open, Save and Close","id":"open-save-and-close","depth":2},{"value":"Query the Model","id":"query-the-model","depth":2},{"value":"Read and Write Parameters","id":"read-and-write-parameters","depth":2},{"value":"Read and Write Data Tables","id":"read-and-write-data-tables","depth":2},{"value":"Add and Delete","id":"add-and-delete","depth":2},{"value":"Copy, Convert, and Rename","id":"copy-convert-and-rename","depth":2},{"value":"Connect and Disconnect","id":"connect-and-disconnect","depth":2},{"value":"Manipulate Fluids","id":"manipulate-fluids","depth":2},{"value":"Import and Export Wells","id":"import-and-export-wells","depth":2},{"value":"Catalog and GIS","id":"catalog-and-gis","depth":2},{"value":"Simulation Settings","id":"simulation-settings","depth":2},{"value":"Simulations","id":"simulations","depth":2},{"value":"Units of Measurement","id":"units-of-measurement","depth":2},{"value":"Data Export","id":"data-export","depth":2},{"value":"Batch Update","id":"batch-update","depth":2},{"value":"Utility Functions","id":"utility-functions","depth":2},{"value":"Convert Bottom Measured Depth","id":"convert-bottom-measured-depth","depth":3},{"value":"Exploring the Model Further","id":"exploring-the-model-further","depth":1},{"value":"Quick Reference","id":"quick-reference","depth":1},{"value":"Model Class","id":"model-class","depth":2},{"value":"Properties","id":"properties","depth":3},{"value":"Methods","id":"methods","depth":3},{"value":"About Class","id":"about-class","depth":2},{"value":"Properties","id":"properties-1","depth":3},{"value":"Methods","id":"methods-1","depth":3},{"value":"Simulation Settings Class","id":"simulation-settings-class","depth":2},{"value":"Properties","id":"properties-2","depth":3},{"value":"Methods","id":"methods-2","depth":3},{"value":"Fluids Class","id":"fluids-class","depth":2},{"value":"Properties","id":"properties-3","depth":3},{"value":"Methods","id":"methods-3","depth":3},{"value":"Compositional Fluid Class","id":"compositional-fluid-class","depth":2},{"value":"Properties","id":"properties-4","depth":3},{"value":"Methods","id":"methods-4","depth":3},{"value":"Simulation Tasks Class","id":"simulation-tasks-class","depth":2},{"value":"Classes","id":"classes","depth":3},{"value":"Methods","id":"methods-5","depth":3},{"value":"Simulation Result Class","id":"simulation-result-class","depth":2},{"value":"Properties","id":"properties-5","depth":3},{"value":"Methods","id":"methods-6","depth":3},{"value":"Nodal Analysis Result Class","id":"nodal-analysis-result-class","depth":2},{"value":"Properties","id":"properties-6","depth":3},{"value":"Methods","id":"methods-7","depth":3},{"value":"Definitions Sub-Module","id":"definitions-sub-module","depth":2},{"value":"Static Classes","id":"static-classes","depth":3},{"value":"Special Keywords","id":"special-keywords","depth":3},{"value":"Important Notes","id":"important-notes","depth":1},{"value":"Component Conversion","id":"component-conversion","depth":2},{"value":"Component Copying","id":"component-copying","depth":2}],"frontmatter":{"seo":{"title":"Quick Start"}},"lastModified":"2026-05-13T11:13:21.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/solutions/pipesim/quickstart","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}