​
Install

Download the Elodin Client:

FilePlatformChecksum
elodin-aarch64-apple-darwin.tar.gzApple Silicon macOSsha256
elodin-x86_64-unknown-linux-gnu.tar.gzx64 Linuxsha256
elodin-x86_64-pc-windows-msvc.zipx64 Windowssha256

Install the Elodin Python SDK using pip:

Only Linux distributions with glibc 2.35+ are supported. This includes Ubuntu 22.04+, Debian 12+, Fedora 35+, NixOS 21.11+, and other recent distributions.

The SDK is only supported on Linux and macOS. Windows users can still use Elodin by installing and running the simulation server in WSL. Install WSL by following the instructions here. Then, install the Elodin Python SDK in WSL.

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.

In a Windows terminal:

  1. Create a new simulation using the three-body orbit template. 
    .\elodin.exe create --template three-body
  2. Launch the Elodin Client. 
    .\elodin.exe

In a WSL terminal that’s pointed to the same directory as the Windows terminal:

An easy way to open a WSL terminal in the current directory is to run wsl in the Windows terminal.
  1. Run the simulation server.
    The --watch argument enables live-reload. The simulation will restart to pickup the changes whenever the file is updated.
    python3 three-body.py run --watch

​
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

elodin create --template ball
python3 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. 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:

Three-Body Problem

Learn how to model a basic stable three-body problem

Was this page helpful?

Three-Body Orbit Tutorial