Project

Projects are where you can set up, run, and analyze simulations. When you create a project with the API, you can use it to upload mesh files and create simulations using those meshes.

Creating Projects

When you create a project, you must specify a name. The name does not need to be unique. You can also specify a description, but this is optional.

After you create a project, you can update the name and/or the description, create a simulation, upload a mesh, and more. See create_project for syntax and parameters.

For example code, see the Creating a Project section of Run Your First Simulation.

Note

Currently, projects created with the API are only accessible from the API. You will not see projects created with the API in the Luminary Cloud user interface and vice versa.

Uploading Mesh Files

Once you’ve created a project, you can upload one or more meshes. Supported file formats are listed on the learning site. See upload_mesh for syntax and parameters.

The uploaded meshes can later be used to create simulations in the same project.

For example code, see the Upload a Mesh section of Run Your First Simulation.

Create and Run Simulations

After creating a project, you’ll need to use the Project object to create and run a simulation. When you create a simulation, you’ll supply a settings file in JSON format. You can download settings files from the Luminary Cloud user interface. See the learning site for more details. This will return a Simulation object (see Simulation for more info) that is nested within the project. See create_simulation for syntax and parameters.

Note

You can’t create a new simulation using the same mesh and simulation settings as a previously created simulation in the same project. This would create a duplicate, so the API prevents them from being created. Create a new project first, then create a simulation with the same files.

For example code, see the Run a Simulation section of Run Your First Simulation.