API FAQs
This FAQ page acts as a quick reference to the common questions and resources when using the Rescale API. Please find the complete and extended version of the API Documentation here.
These fields go into the data file (cURL) or script (python) in the process of creating a job. Please refer to the tutorial here or the complete API Documentation.
Field | Default | Required | Description |
name | None | Yes | Human friendly name for this job. |
paramFile | None | No | File with parameter variables. |
caseFile | None | No | File with case variables. |
jobvariables | None | No | List of job variables for this job. See details in section below. |
jobanalyses | None | Yes | List of analyses for this job. See details in section below. |
resourceFilters | Default filters | No | List of filtering rules for output files. |
isTemplateDryRun | False | No | Run this job in “dry run” mode. |
includeNominalRun | False | No | Include the run with nominal variables. |
monteCarloIterations | None | No | Number of iterations in case the variables use a monteCarlo generator type. |
You can get the full list of codes and options by calling curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/analyses/
Here are the codes of the more common softwares:
Analysis | Code |
Abaqus | abaqus |
COMSOL | comsol |
CONVERGE | converge_open_mpi |
OpenFOAM | openfoam |
STAR-CCM+ | cd_adapco_star_ccm |
XFlow | xflow |
Note: Don’t forget to include the field "useRescaleLicense":true
if you are purchasing on demand licenses for your software through Rescale.
You can get the full list of codes and options by calling curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/coretypes/
.
Here are the codes of the more common core types:
Core Type | Code |
Emerald | hpc-3 |
Nickel | hpc-plus |
Marble | standard-plus |
Obsidian | obsidian |
Titanium | titanium |
Iron | hpc-infiniband |