Questions? Feedback? powered by Olark live chat software
Resources Home

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.

What are the common fields needed to set up a job?

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.

What is the code for the Analysis software I want to use?

You can get the full list of codes and options by calling curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/remote-viz-config/.

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.

What is the code for the core type I want to use?

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
Onyx
hpc-3
Nickel
hpc-plus
Marble
standard-plus
Obsidian
obsidian
Titanium
titanium
Iron
hpc-infiniband

Last Updated: Jan 05, 2017 01:16PM PST

Powered by Desk.com
c63bcf49f4eed122cd69ef16269a7198@rescale.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete