hpcflow.app.ResourceSpec#

class hpcflow.app.ResourceSpec(scope=None, scratch=None, num_cores=None, scheduler=None, shell=None, use_job_array=None, time_limit=None, scheduler_options=None, scheduler_args=None, shell_args=None, os_name=None)#

Bases: ResourceSpec

Methods

from_json_like

make_persistent

Save to a persistent workflow.

to_dict

to_json_like

Attributes

ALLOWED_PARAMETERS

app

element_set

normalised_path

normalised_resources_path

num_cores

os_name

scheduler

scheduler_args

scheduler_options

scratch

shell

shell_args

time_limit

use_job_array

workflow

workflow_template

Parameters:

  • scope (app.ActionScope) –

  • scratch (Optional[str]) –

  • num_cores (Optional[int]) –

  • scheduler (Optional[str]) –

  • shell (Optional[str]) –

  • use_job_array (Optional[bool]) –

  • time_limit (Optional[Union[str, timedelta]]) –

  • scheduler_options (Optional[Dict]) –

  • scheduler_args (Optional[Dict]) –

  • shell_args (Optional[Dict]) –

  • os_name (Optional[str]) –

ALLOWED_PARAMETERS = {'num_cores', 'os_name', 'scheduler', 'scheduler_args', 'scheduler_options', 'scratch', 'shell', 'shell_args', 'time_limit', 'use_job_array'}#
app = BaseApp(name='hpcFlow', version='0.2.0a64')#
property element_set#
classmethod from_json_like(json_like, shared_data=None)#
Parameters:

  • json_like (Union[Dict, List]) –

  • shared_data (Optional[Dict[str, ObjectList]]) –

make_persistent(workflow, source)#

Save to a persistent workflow.

Returns:

  • String is the data path for this task input and integer list

  • contains the indices of the parameter data Zarr groups where the data is

  • stored.

Parameters:
Return type:

Tuple[str, List[int], bool]

property normalised_path#
property normalised_resources_path#
property num_cores#
property os_name#
property scheduler#
property scheduler_args#
property scheduler_options#
property scratch#
property shell#
property shell_args#
property time_limit#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
property use_job_array#
property workflow#
property workflow_template#