This tool provides an intuitive interface for users to set up, execute, and expand their simulation projects with minimal coding effort. Leveraging cutting-edge performance, Inductiva API simplifies the intricate processes, enabling users to focus on results with just a few Python commands.
This API offers a range of benefits for diverse simulation needs:
Versatile Simulation Integration It unites various simulation fields such as fluid dynamics, molecular dynamics, plasma physics, and structural mechanics into a single, accessible platform.
Simplified Setup Users are freed from the complexities of installing and maintaining intricate simulation software and dependencies.
Scalable Execution Facilitates the execution of hundreds to thousands of simultaneous simulations, effortlessly and without extensive coding.
Optimized Hardware Utilization Automatically tailors hardware settings to each simulation type, optimizing the use of CPU and GPU resources, core counts, and memory.
Python-Centric Flexibility Foregoing restrictive GUIs and complex configuration scripts, Inductiva API allows for the creation of concise Python programs that integrate smoothly with existing codebases and machine learning frameworks.
Inductiva package is simple to install, just run on your terminal:
pip install --upgrade inductiva
This will provide the core functionalities of the API, which allows you to submit jobs, control machines and run simulations. To use the visualization and post-processing tools, you need to install additional optional dependencies specific to different scientific domains: molecules_extra, fluids_extra or coastal_extra. For example, for fluid dynamics:
pip install --upgrade "inductiva[fluids_extra]"
If you have issues with the installation, check the Installation troubleshooting for more information.
Please request API token and add the following line to your code:
import inductiva
inductiva.api_key = "YOUR_API_KEY"Similarly, you can set the INDUCTIVA_API_KEY as an environment variable in your terminal as follows:
export INDUCTIVA_API_KEY="YOUR_API_KEY"And you are good to go! You can start exploring Inductiva API with the examples below.
Inductiva API contains pre-built simulation scenarios that define physical systems of interest ready to simulate. Users can choose some parameters and configure the system according to their needs, run the simulation using the most adequate resources and visualize the results.
To run this simulation and render the visualizations install the fluids extra dependencies with
!pip install --upgrade inductiva[fluids_extra]Follow the example with:
import inductiva
inductiva.api_key = "YOUR_API_KEY"
# Url to a test object in Inductiva Github repository
vehicle_url = "https://raw.githubusercontent.com/inductiva/inductiva/main" \
"/assets/vehicle.obj"
vehicle_path = inductiva.utils.files.download_from_url(vehicle_url)
# Initialize the scenario
scenario = inductiva.fluids.WindTunnel(
flow_velocity=[30, 0, 0],
domain={"x": [-5, 15], "y": [-5, 5], "z": [0, 8]})
# Run a simulation
task = scenario.simulate(
object_path=vehicle_path, num_iterations=50, resolution="low")
# Download the simulation output to your local machine.
output = task.get_output()
# Get the pressure field over the object
pressure_field = output.get_object_pressure_field()To render the post-processing on a computer with physical display run:
pressure_field.render()Or, in Colab or headless server, install the extra dependencies with
!apt install libgl1-mesa-glx xvfb
and run:
pressure_field.render(virtual_display=True, save_path="pressure_field.png")These are the currently available scenarios:
Inductiva API has available several open-source simulators ready to use. Users familiar with the simulators can easily start running simulations with their previously prepared simulation configuration files. In this way, they can take advantage of performant hardware to speed up their simulation and exploration.
The simulators we provide are all open-source and have their own dedicated documentation:
To learn how to use these simulators with Inductiva API, check the example below and the Simulators section.
If you would like other simulators to be added, contact us at simulations@inductiva.ai.
Example of how to use the simulators:
import inductiva
inductiva.api_key = "YOUR_API_KEY"
# Download the configuration files
input_dir = inductiva.utils.files.download_from_url(
"https://storage.googleapis.com/inductiva-api-demo-files/"
"dualsph-flow-cylinder.zip"
)
# Initialize the Simulator
simulator = inductiva.simulators.DualSPHysics()
# Run the simulation
task = simulator.run(input_dir=input_dir)The user must specify the input directory containing the files to run the simulation. In the above example, a directory with the configuration of a simulation is downloaded, and passed as argument to the simulator call.
Inductiva API allows you to launch multiple simulations in parallel. After a simulation is submitted, users are free to execute other commands, since simulation run independently in the background. Users are not limited by waiting for the simulation to finish.
Users can prepare several simulations and launch them all together in parallel. Let's look at an example using the wind tunnel scenario:
import inductiva
vehicle_url = "https://raw.githubusercontent.com/inductiva/inductiva/main" \
"/assets/vehicle.obj"
vehicle_path = inductiva.utils.files.download_from_url(vehicle_url)
task_list = []
velocity_list=[1, 10, 20, 30, 40]
for velocity in velocity_list:
scenario = inductiva.fluids.WindTunnel(flow_velocity=[velocity, 0, 0])
task = scenario.simulate(object_path=vehicle_path)
task_list.append(task)All simulations are launched in one go, allowing users to continue working on other things. To monitor the progress of individual simulations, users can use task.get_status(), or they can view a list of the most recent tasks launched by using inductiva.tasks.list(last_n=5).
Finally, to retrieve the results the user can use task.get_output(), which waits for the simulation to finish before downloading the results. During this waiting period, it temporarily blocks the execution of other code. Check the Tasks section for more information on how to do this.
Depending on your shell, you may encounter issues when trying to install optional packages such as inductiva[molecules_extra]. This is because certain shells interpret brackets, like those in [molecules_extra], in a special way. To prevent any misinterpretation or errors, enclose the package name and its extras in double quotes. To ensure a successful installation, please use the following command:
pip install --upgrade "inductiva[molecules_extra]"If installing the package failed, you can retry it on a new Python virtual environment. A virtual environment allows you to have a fresh Python environment with isolated dependencies. In your shell, run:
python -m venv <venv>
In that command, you should replace <venv> with the path (e.g., .venv) in which you would like to create the environment. Then, to activate the environment (again, correctly replacing <venv>), run:
For bash/zsh:
source <venv>/bin/activate
For cmd.exe (Windows):
<venv>\Scripts\activate.bat
For PowerShell (Windows):
<venv>\Scripts\Activate.ps1
After activating the virtual environment, you can install the package as described below:
pip install --upgrade inductiva





