Active Petrel user#

As an active Petrel user, you will have minimal exposure to Hub. You will be using Hub to connect your Python environment with another Prizm module such as Investigator or Python Tool Pro. A Hub Server is needed for this connection. This Hub Server will be either local, started by you from Marina within Petrel, to connect to a local Python environment or it will be hosted on a remote network. The configuration of the Hub Server on remote network will be done by the Hub admin in your organization if hosted on-prem or in-house. If you are using a Cegal hosted solution like Cegal Innovation Space the configuration of the Hub Server will be done by Cegal.

Note

It is recommended that the Hub Connection is configured to be established automatically on Petrel start-up. This can be done centrally for all users. This chapter shows how to set up the connection manually.

Local Petrel and Python environment#

../../../_images/Hub_ActivePetrelUser_local.png ../../../_images/Hub_ActivePetrelUser_local_dark.png

In this use case you will have a local Python environment and an active Petrel instance with an open UI. To connect other Prizm modules from your local Python environment to Petrel you will need to start a Hub Server. To start a Hub Server locally open the Hub Petrel plug-in in Marina.

../../../_images/Open_Hub_from_Marina.png

In the pane ‘Hub Server Connection’ select ‘Use local Hub Server’ and click ‘Connect’.

../../../_images/HubLocalConnection_setup1.png

After you click ‘Connect’ the Hub Petrel plug-in checks if a local Hub Server is already running and will connect to it. If no local Hub Server is running a new Hub Server will be started using the Hub binary file located in ‘C:\Program Files\Cegal\Hub’. Then a connection is established to the local Hub Server. After the connection is established the ‘Petrel Connector status’ and ‘Hub Server status’ will change to ‘True’.

../../../_images/Hub_server_status_True1.png

Now that the Hub connection is established you can start using other Prizm modules. An example of connecting to your local Hub Server from a Jupyter Notebook can be found here:

Connecting Hub to a remote environment#

../../../_images/Hub_ActivePetrelUser_remote.png ../../../_images/Hub_ActivePetrelUser_remote_dark.png

In this use case you will connect to a Hub Server running on a remote network. This can be an in-house solution, or a solution hosted by Cegal. It is assumed that the Hub Server is set up and configured by the Hub admin in your organization or in case of a Cegal hosted solution by Cegal. You, as a Petrel user, will only need to connect to the remote address of the Hub Server. For more information on the configuration of the Hub Server please check Hub Server Configuration.

To connect to a Hub Server running on a remote network open the Hub Petrel plug-in in Marina.

../../../_images/Open_Hub_from_Marina.png

In the pane Hub Server Connection select ‘Use remote Hub Server’. The server address is the address of the remote network the Hub Server is running on. Your Hub admin can provide this information to you. The server port is usually 443 and ‘Use TLS’ should be checked. The Hub Petrel plug-in will now try to connect to the Hub Server on the given address. After a few seconds, the Hub Server status will show ‘Running: True’.

../../../_images/HubRemoteConnection_setup1.png

Then click the ‘Connect’ button and a connection to the remote Hub Server will be established. The Petrel Connector status will change to ‘Connected: True’.

../../../_images/Hub_connector_status_True1.png

Now that the Hub connection is established you can start using other Prizm modules. An example of connecting to Petrel from a remote Hub Server can be found here: