Skip to main content

Start Simulation

Here is how to start your very first simulation.

  1. Generate a new example project.
  2. Create & Upload a MC (Monte Carlo) configuration.
  3. Validate your MC config.
  4. Start the simulation!
from almanak import Almanak

# Instantiate your Almanak client.
client = Almanak(
    api_key="<YOUR_API_KEY>",
)

# 1. Generate a boilertemplate for a simulation
client.simulations.monte_carlo.generate("MyNewSimulation")

# 2. Create a monte carlo simulation and get the upload link for config zip
data = client.simulations.monte_carlo.create_mc_upload_config(
    "./MyNewSimulation/config"
)
print(data)

# 3. Validate the configuration before launching the simulation
validateResult = client.simulations.monte_carlo.validate_mc_config(
    data["monte_carlo_id"]
)
print(validateResult)

# 4. Start the simulation!
startMCResult = client.simulations.monte_carlo.start(data["monte_carlo_id"])
print(startMCResult)

You can now look at the Results Tutorial