ApiGateway#

Qualified name: api.api\_gateway.ApiGateway

class api.api_gateway.ApiGateway(proj)[source]#

Bases: object

Entry point for the MORe API

Only this object needs to be imported and initialized by the API user. All other objects are created by this object.

Parameters:

proj (Project) – The project instance

Methods

create_simulation_setup

Creates a SimulationSetup object for managing simulations
create_simulation_setup() → SimulationSetup[source]#

Creates a SimulationSetup object for managing simulations

Example

>>> from more.api import ApiGateway
>>> setup = ApiGateway(proj=proj).create_simulation_setup()
Returns:

A SimulationSetup instance for managing the simulation state

Return type:

SimulationSetup