Quick Start

Install Elodin and start simulating.

Install

Download the Elodin Client:

Install the Elodin Python SDK using pip:

pip install -U elodin

Start Simulating

Windows (WSL)

To use Elodin on Windows, the simulation server must run in Windows Subsystem for Linux (WSL). The Elodin Client itself can run natively on Windows.

Video Walkthrough

In a Windows terminal launch the Elodin app.

.\elodin.exe

In a WSL terminal download and install elodin binary into your path then run:

1. Create a new simulation using the three-body orbit template.

   elodin create --template three-body
   

2. Run the simulation server.

   elodin run three-body.py
   

Linux / macOS

1. Create a new simulation using the three-body orbit template.

   elodin create --template three-body
   

2. Launch the simulation using the elodin CLI.

   elodin editor three-body.py
   

Perform Analysis

To analyze simulation data, use the Exec API to run the simulation for some number of ticks and collect the historical component data as a [Polars DataFrame]. The DataFrame can then be used to generate plots or perform other methods of data analysis.

Run the bouncing ball example code to see this in action:

The ball/plot.py example depends on matplotlib. Install it using pip:

pip install -U matplotlib

Then create & run the ball template:

elodin create --template ball
python3 ball/plot.py

For more information on data frames check out Polars DataFrame

Monte Carlo

Run Monte Carlo simulations to explore the state space.

1. Create an account at https://app.elodin.systems to receive 60 free minutes of hosted simulation time (per month).
2. Authorize elodin to access the Monte Carlo platform.

   elodin login
   

3. Create a new simulation from the bouncing ball template, which includes random sampling and asserts.

   elodin create --template ball
   

4. Start a 100 sample Monte Carlo run with a maximum sim duration of 15s.
   Add --open to automatically open the dashboard url in the browser.

   elodin monte-carlo run --name ball ball/main.py --max-duration 15 --samples 100
   

Next Steps

Try out the following tutorials to learn how to build simulations using Elodin: