You can simulate Teamwork Cloud projects on the server by using Jupyter Notebook. This chapter explains how to set up Jupyter Notebook for server-side simulation and lists all available commands with examples. Prerequisites Before starting the simulation, make sure you have prepared your projects for server-side simulation. To set up Jupyter Notebook In Jupyter Notebook, run the following command to install a Python package from the <modeling_tool_installation_directory>\plugins\com.nomagic.magicdraw.simulation\pyST.zip file: Use the following requests to simulate Teamwork Cloud projects on the server: client = SimulationWebClient('http(s)://<server_host>:<server_port>', '<TWC_user_name>', '<TWC_user_password>', False) The following table describes the parameters used in the request: The Teamwork Cloud user name. If you do not specify the user name in the request, an input field will be provided to specify it later. For instructions on how to run server-side simulation using SSL, refer to Running server-side simulation with SSL client.get_projects() client.run(<project>, version=<version>, branch=<branch>, element_id=<element_id>, config=<config>, commit_results=<True/False>, verification=<All/None/Fail>, data=json.dumps(<param> ), auto_start=<True/False> ) The following table describes the parameters used in the request: Starts the simulation automatically after the initialization phase is completed. Available values are: false - only the initialization phase of the simulation is performed. The simulation then waits for an invocation to start the simulation, do a step, or terminate the simulation. Commits a new project version with the simulation results. Available values are True or False (default). Returns the selected verification results. Available values are: client.step(<simulation_id>) The following table describes the parameters used in the request: client.start(<simulation_id>) The following table describes the parameters used in the request: client.simulate(<project>, version=<version>, branch=<branch>, element_id=<element_id>, config=<config>, commit_results=<True/False>, verification=<All/None/Fail>, data=json.dumps(<param>)) The following table describes the parameters used in the request: A new project version is committed with the simulation results. Available values are True or False (default). Returns the selected verification results. Available values are: If the verification value is not specified, only the verification results with the fail status are returned when the get_results endpoint is called. client.get_status(<simulation_id>) The following table describes the parameters used in the request: client.get_variables(<simulation_id>, variables=json.dumps(<parameters>)) The following table describes the parameters used in the request: client.set_variables(<simulation_id>, variables=json.dumps(<parameters>)) The following table describes the parameters used in the request: client.pause(<simulation_id>) The following table describes the parameters used in the REST API request: client.resume(<simulation_id>) The following table describes the parameters used in the REST API request: client.get_result(<simulation_id>) The figure below demonstrates how to specify input and output parameters. The following table describes the parameters used in the request: client.terminate(<simulation_id>) The following table describes the parameters used in the request: client.has_configurations(<project>, version=<version>, branch=<branch>) The following table describes the parameters used in the request: client.get_configurations(<project>, version=<version>, branch=<branch>, element_id=<element_id>) The following table describes the parameters used in the request: Returns Simulations Configurations with a specified UI tag for a particular project. The only possible value for the filter parameter is ui. Only Simulations Configurations having at least one of the following UI elements are returned: client.get_descriptor(<project>, version=<version>, branch=<branch>, config=<config>) The following table describes the parameters used in the request:Setting up Jupyter Notebook
%pip install pyST.zip
Create client/session and authenticate
This request starts a work session and provides authentication to Teamwork Cloud.Parameter In Required or optional Description server_host path required The Teamwork Cloud server host name. server_port path required The Teamwork Cloud server port. TWC_user_name path optional TWC_user_password path optional The Teamwork Cloud password. If you do not specify the password in the request, an input field will be provided to specify it later.
Get the list of Teamwork Cloud projects
This request provides the list of Teamwork Cloud projects accessible to you depending on your permissions. Only projects that you can read (the Read Resources permission) are returned.client.get_projects()
[{'id': '1f9fd988-620b-4b3c-8414-7ab96dc53a48',
'name': 'SpacecraftMassRollup',
'description': ''},
{'id': 'c125b91e-7d31-4015-b659-6fd98059b8c7',
'name': 'BouncingBall',
'description': 'This project demonstrates the execution of the BouncingBall, including fmu.'},
{'id': '485dfc82-7b08-43cd-86b1-953b3725e5b1',
'name': 'CarBrakingAnalysis',
'description': 'This project calculates the stopping distance based on car speed and mass.'}]
Run simulation
This request initiates the execution of the specified Simulation Configuration in a particular project. It connects to Teamwork Cloud, finds the element to execute, and initiates the execution if the element exists. After the execution is complete, the request constructs and returns a unique ID (per application) for the given execution.Parameter In Required or optional Description project path required The Teamwork Cloud project name or ID. version path optional The Teamwork Cloud project version. branch path optional The project branch name or ID. If the branch is omitted, the trunk is used instead. element_id path optional The server ID of the Instance Specification to be executed. config path required The Simulation Configuration name or server ID. auto_start path optional started_from path optional Allows specifying the starting location of the simulation. The value of the started_from parameter is provided in the status endpoint response. commit_results path optional verification path optional data path optional A set of output parameters, which will be obtained after the simulation is complete. # SpaceCraftMassRollup sample
parameters = {
"inputs":
{
"telecom.antenna.me":10,
"telecom.amplifier.me":20
},
"outputs":
[
"me",
"propulsion.me",
"propulsion.tank.me",
"propulsion.thruster.me",
"telecom.me",
"telecom.antenna.me",
"telecom.amplifier.me"
]
}
client.run('SpacecraftMassRollup_SimWeb', config='spacecraft mass analysis', commit_results=False, data=json.dumps(parameters))
Perform a time step
This request performs a single time step of the specified simulation. To run the simulation by step, it should be run with the auto_start query parameter set to false .Parameter In Required or optional Description simulation_id path required The ID of a specific simulation.
Start simulation
This request starts the execution of the specified simulation. If the initialization phase is still in progress, the start endpoint is memorized and sent when the initialization phase is completed.Parameter In Required or optional Description simulation_id path required The ID of a specific simulation.
Start simulation and get results
This request starts simulation and returns its results.Parameter In Required or optional Description project path required The Teamwork Cloud project name or ID. version path optional The Teamwork Cloud project version. branch path optional The project branch name or ID. If the branch is omitted, the trunk is used instead. element_id path optional The server ID of the Instance Specification to be executed. config path required The Simulation Configuration name or server ID. commit_results path optional verification path optional data path optional A set of output parameters, which will be obtained after the simulation is complete. # SpaceCraftMassRollup sample
parameters = {
"inputs":
{
"telecom.antenna.me":10,
"telecom.amplifier.me":20
},
"outputs":
[
"me",
"propulsion.me",
"propulsion.tank.me",
"propulsion.thruster.me",
"telecom.me",
"telecom.antenna.me",
"telecom.amplifier.me"
]
}
client.simulate('SpacecraftMassRollup_SimWeb', config='spacecraft mass analysis', commit_results=False, data=json.dumps(parameters))
Get simulation status
This request gets the status of a specific simulation. If the model has a UI mockup, Time Series Chart, Timeline Chart, or HTML Table, you can use the URL provided in the 'ui' or indexUI' key to open the specified UI.Parameter In Required or optional Description simulation_id path required The ID of a specific simulation. client.get_status('77d0c496-c1e2-42cd-8ba4-04e4c7f359d3')
{'state': 'RUNNING',
'simulationId': '77d0c496-c1e2-42cd-8ba4-04e4c7f359d3',
'simulationTime': '0 ms',
'indexUI': 'http://nm-simulation.dsone.3ds.com/simulation/api/ui/index/77d0c496-c1e2-42cd-8ba4-04e4c7f359d3?pages=Coffee%20Machine.html&pages=Water%20Heating%20Element.html&pages=Wallet.html',
'project': 'CoffeeMachine',
'config': 'Coffee Machine',
'elapsedTime': 0,
'podName': 'simulation-deployment-6989d5dfc9-r6llk',
'ui': ['http://nm-simulation.dsone.3ds.com/simulation/api/ui/77d0c496-c1e2-42cd-8ba4-04e4c7f359d3/Coffee%20Machine.html',
'http://nm-simulation.dsone.3ds.com/simulation/api/ui/77d0c496-c1e2-42cd-8ba4-04e4c7f359d3/Water%20Heating%20Element.html',
'http://nm-simulation.dsone.3ds.com/simulation/api/ui/77d0c496-c1e2-42cd-8ba4-04e4c7f359d3/Wallet.html']}
client.get_status('ce8c8215-0515-43fd-9d34-92d1d7a95d87')
{'state': 'COMPLETED',
'simulationId': 'ce8c8215-0515-43fd-9d34-92d1d7a95d87',
'simulationTime': '3000 ms',
'project': 'SpacecraftMassRollup',
'config': 'spacecraft mass analysis',
'elapsedTime': 6598}
client.get_status('b7bdf933-f58d-4e7e-b73b-8370c60485cd')
{'state': 'QUEUED',
'queueNumber': 3,
'simulationId': 'b7bdf933-f58d-4e7e-b73b-8370c60485cd',
'simulationTime': '0 ms',
'project': 'CarBrakingAnalysis',
'elapsedTime': 52}
Get simulation variables
This request returns a list of simulation variables during simulation.Parameter In Required or optional Description simulation_id path required The ID of the running simulation. variables path optional The set of simulation variables that should be obtained. If no variables are specified, the values of all simulation variables are returned. Set simulation variables
This request provides a list of simulation variables with values. Parameter In Required or optional Description simulation_id path required The ID of the running simulation. variables path required The set of simulation variables with values that should be used during the current simulation. context path optional The context ID. property_path path optional The property path of the context specified using property names or IDs. var = {
"variables":
{
"position": 40
}
}
client.set_variables('23ceff24-28fa-47e4-b29f-b6b60b4b12e3', variables=json.dumps(var))
Pause simulation
This request pauses the execution of the specified simulation.Parameter In Required or optional Description simulation_id path required The ID of the running simulation.
Resume simulation
This request resumes the execution of the specified simulation.Parameter In Required or optional Description simulation_id path required The ID of the running simulation.
Get simulation results
This request returns the results of the specified simulation. If the OutputParameters tag of the executed Simulation Configuration is specified, the results are provided according to the OutputParameters tag value. If a Time Series or Timeline chart is specified for the Simulation Configuration, the chart data is returned in the JSON format.
Specifying input and output parameters.
Parameter In Required or optional Description simulation_id path required The ID of the running simulation.
Get the list of running simulationsclient.get_running()
This REST API request gets the list of all currently running simulations including the queued simulations that are placed in a waiting line.
Terminate simulation
This request terminates the specified simulation.Parameter In Required or optional Description simulation_id path required The ID of a specific simulation.
Check for Simulation Configurations
This request checks if the project has any Simulation Configurations.Parameter In Required or optional Description project path required The Teamwork Cloud project name or ID. version path optional The Teamwork Cloud project version. branch path optional The project branch name or ID. If the branch is omitted, the trunk is used instead.
Get Simulation Configurations
This request retrieves the names and descriptions of the Simulation Configurations available for the given project.Parameter In Required or optional Description project path required The Teamwork Cloud project name or ID. version path optional The Teamwork Cloud project version. branch path optional The project branch name or ID. If the branch is omitted, the trunk is used instead. element_id path optional The server ID of the Instance Specification to be executed. filter path optional
Get Simulation Configuration descriptor
This REST API request retrieves Simulation Configuration data (description, execution target, time step, input and output parameters) from the specified project. The set of input and output parameters is specified using the Input Parameters and Output Parameters properties of a Simulation Configuration. The figure below demonstrates how to specify input and output parameters.Specifying input and output parameters.
Parameter In Required or optional Description project path required The Teamwork Cloud project name or ID. version path optional The Teamwork Cloud project version. branch path optional The project branch name or ID. If the branch is omitted, the trunk is used instead. config path required The Simulation Configuration name or server ID. client.get_descriptor('SpacecraftMassPollup_SimWeb', config='spacecraft mass analysis')
{'config': 'spacecraft mass analysis',
'description': 'Simulation Config that is dedicated to run spacecraft mass rollup.',
'model': 'spacecraft',
'parameters': {'inputs': [{'parameter': 'telecom.amplifier.me',
'value': 32.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]},
{'parameter': 'telecom.antenna.me',
'value': 32.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]},
{'parameter': 'propulsion.tank.me',
'value': 68.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]},
{'parameter': 'propulsion.thruster.me',
'value': 68.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]}],
'outputs': [{'parameter': 'telecom.me',
'value': 32.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]},
{'parameter': 'propulsion.me',
'value': 68.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]},
{'parameter': 'me',
'value': 95.0,
'type': 'mass[kilogram]',
'unit': 'kilogram',
'requirements': [{'id': '1',
'text': 'Estimated mass shall be less than allocated mass'}]}]}}
client.get_descriptor('BouncingBall', config='Run BouncingBall')
{'config': 'Run BouncingBall',
'description': 'Simulation Config dedicated to run simulation with bouncingBall.fmu.',
'model': 'bouncingBall',
'timeStep': '10 ms'
}
Request and response examples
The ?autoStart query parameter is ignored when multiple iterations are running, e.g. Tradestudy, Montecarlo, or table simulation
Request and response examples
Request and response examples
Request and response examples
Request and response examples
Request and response examples