Quick Start

​

Install

Install the Elodin Python SDK using pip:

pip install elodin

Download the Elodin Client:

​

Start Simulating

1. Download the three-body.py example code from our Github repo: elodin-sys/elodin.
2. Launch the simulation server and enter a Python REPL.
   The --watch argument enables live-reload. The simulation will restart to pickup the changes whenever the file is updated.

   python three-body.py run --watch
   

3. Launch the Elodin Client (3D viewer and component inspector).
   elodin.exe on Windows
   elodin --help for more information

   elodin
   

​

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 ball-plot.py example code to see this in action.

pip install matplotlib

python ball-plot.py

​

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. Download the ball.py example, which includes random sampling and asserts.
4. Start a 300 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.py --max-duration 15 --samples 300
   

​

Next Steps

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