Skip to content
Snippets Groups Projects
Commit c81502d5 authored by Mikhail Karnevskiy's avatar Mikhail Karnevskiy
Browse files

Update workflow.rst

parent 68dbd9c7
No related branches found
No related tags found
1 merge request!58Extend description of boolean variables
...@@ -92,7 +92,7 @@ required:: ...@@ -92,7 +92,7 @@ required::
cluster_profile = "noDB" # The ipcluster profile to use cluster_profile = "noDB" # The ipcluster profile to use
local_output = False # output constants locally local_output = False # output constants locally
Here, `in_folder` and `out_folder` are required string values. Values for required parameters have to be given when executing from the command line. This means that any defaults given in the first cell of the code are ignored (they are only used to derive the type of the parameter). `Modules` is a list, which from the command line could also be assigned using a range expression, e.g. `5-10,12,13,18-21`, which would translate to `5,6,7,8,9,12,13,18,19,20`. It is also a required parameter. The parameter `local_output` is a Boolean. The corresponding argument given in the command line will change this parameter from `false` to `True`. There is not a way to change this parameter from `True` to `False` from the command line. Here, `in_folder` and `out_folder` are required string values. Values for required parameters have to be given when executing from the command line. This means that any defaults given in the first cell of the code are ignored (they are only used to derive the type of the parameter). `Modules` is a list, which from the command line could also be assigned using a range expression, e.g. `5-10,12,13,18-21`, which would translate to `5,6,7,8,9,12,13,18,19,20`. It is also a required parameter. The parameter `local_output` is a Boolean. The corresponding argument given in the command line will change this parameter from `false` to `True`. There is no way to change this parameter from `True` to `False` from the command line.
The `cluster_profile` parameter is a bit special, in that the tool kit expects exactly this The `cluster_profile` parameter is a bit special, in that the tool kit expects exactly this
name to provide the profile name for an ipcluster_ being run. Hence you use `ipcluster` name to provide the profile name for an ipcluster_ being run. Hence you use `ipcluster`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment