Job Management Service (JMS)

Ansys HPS includes the Job Management Service (JMS), which is the main service for storing and evaluating jobs using multiple heterogeneous compute resources.

The ansys.hps.client.jms Python subpackage wraps around the JMS REST API, which is available at https://hostname:port/hps/jms/api.

APIs

JmsApi(client)	Wraps around the JMS root endpoints.
ProjectApi(client, project_id)	Exposes the project endpoints of the JMS.

Resources

File([src, id, creation_time, ...])	Provides the file resource.
Project([id, name, active, priority, ...])	Provides the project resource.
FitnessTermDefinition([id, name, ...])	Provides the fitness term definition resource.
FitnessDefinition([id, ...])	Provides the fitness definition resource.
FloatParameterDefinition([id, ...])	Provides the float parameter definition resource.
BoolParameterDefinition([id, creation_time, ...])	Provides the bool parameter definition resource.
IntParameterDefinition([id, creation_time, ...])	Provides the int parameter definition resource.
StringParameterDefinition([id, ...])	Provides the string parameter definition resource.
ParameterMapping([id, creation_time, ...])	Provides the parameter mapping resource.
Software([name, version])	Provides the software resource.
HpcResources([num_cores_per_node, ...])	Provides the hpc resources resource.
ResourceRequirements([platform, memory, ...])	Provides the resource requirements resource.
SuccessCriteria([return_code, expressions, ...])	Provides the success criteria resource.
Licensing([enable_shared_licensing])	Provides the licensing resource.
TaskDefinition([id, creation_time, ...])	Provides the task definition resource.
TaskCommandDefinition([id, creation_time, ...])	Provides the task command definition resource.
JobDefinition([id, creation_time, ...])	Provides the job definition resource.
Task([id, creation_time, modification_time, ...])	Provides the task resource.
TaskCommand([id, creation_time, ...])	Provides the task command resource.
Job([id, creation_time, modification_time, ...])	Provides the job resource.
JobSelection([id, creation_time, ...])	Provides the job selection resource.
Algorithm([id, creation_time, ...])	Provides the algorithm resource.
TemplateProperty([default, description, ...])	Provides the template property resource.
TemplateResourceRequirements([platform, ...])	Provides the template resource requirements resource.
TemplateInputFile([name, type, ...])	Provides the template input file resource.
TemplateOutputFile([name, type, ...])	Provides the template output file resource.
TaskDefinitionTemplate([id, ...])	Provides the task definition template resource.
Permission([permission_type, value_id, ...])	Provides the permission resource.