inductiva 0.4.3

Python client for the Inductiva API

Inductiva API Python client

Inductiva is a Python package for executing large-scale simulations of physical systems directly in the cloud.

Inductiva API offers distinct advantages:

• 🔄 It consolidates various simulation domains, including fluid and molecular dynamics, plasmas, and structural mechanics, under a single unified entry point.
• 📦 Eliminates the need for installing and managing complex simulation software and corresponding dependencies.
• 🚀 Allows running hundreds or even thousands of simulations concurrently, with no coding.
• 💽 Automatically optimizes hardware configurations for each type of simulation (e.g., CPU vs. GPU, appropriate number of CPU cores, RAM, etc.).
• 🐍 With Inductiva API, you are not limited to a pre-defined GUI or intricate configuration languages and scripts. Instead, you write small Python programs that seamlessly integrate with your existing codebase and ML framework.

Follow our documentation to learn more about Inductiva API and how to use it.

Simulators

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.

Check the following pages for additional details on how to use them with Inductiva API:

• SPlisHSPlasH
• DualSPHysics
• OpenFOAM
• SWASH
• XBeach
• Reef3D
• GROMACS
• FDS

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 [e-mail].

Installation

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.

If you have issues with the installation, check the Installation troubleshooting for more information.

API access tokens

Please request API token and set your 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 example below.

Example

Example of how to use the simulators:

import inductiva

# Download the configuration files
input_dir = inductiva.utils.download_from_url(
    "https://storage.googleapis.com/inductiva-api-demo-files/"
    "reef3d-input-example.zip", unzip=True
)

# Initialize the Simulator
simulator = inductiva.simulators.REEF3D()

# Run the simulation
task = simulator.run(input_dir=input_dir)

# Wait for the simulation to finish and download the outputs
task.wait()
task.download_outputs()

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.

More info:

• Managing submitted tasks
• Managing computation resources

Installation troubleshooting

Why my current installation of Inductiva package is not working?

If you have installed Inductiva package before, you may need to upgrade it to the latest version. To do so, upgrade the package with the following command:

pip install --upgrade inductiva

Why can't I install Inductiva package?

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