How-to guides

Configuration

Get and set config items

Using the config sub-command in the hpcFlow CLI, we can get configuration items like this:

hpcflow config get machine

Items can be set like this:

hpcflow config set machine my-machine-name

---

In the Python API, we can interact with the hpcFlow configuration as below. Note that we must call config.save to make the config changes persistent, otherwise any changes made will only be temporary.

import hpcflow.app as hf

# print the value of the `machine` item:
print(hf.config.machine)

# set the value of the `machine` item:
hf.config.machine = "my-machine-name"

# save the changes to the config file:
hf.config.save()

See the configuration reference documentation for a listing of configurable items.

Template components

How to name parameters and task schemas

Parameter type names (i.e. the typ attribute) must be valid Python identifiers. This means that they cannot start with a number. They must also be fully alphanumeric, but may include underscores (but not at the start). These rules also apply to task schema methods, implementations, and objective names. See hpcflow.sdk.core.utils.check_valid_py_identifier() for more details. By convention, lower case is preferred, except for acronyms and initialisms.