diff --git a/docs/source/start.rst b/docs/source/start.rst index 98c15279a72..c9b615681c8 100644 --- a/docs/source/start.rst +++ b/docs/source/start.rst @@ -61,3 +61,25 @@ Scrontab instead launches a script and requires SCRON directives to launch an sb #SCRON --time=00:10:00 */5 * * * * /path/to/rocoto/launch/script + +.. note:: + When running rocoto via scrontab, it is not possible to run rocoto's queue server, so this feature must be disabled. This is accomplished by editing the rocotorc file. This file is created when rocotorun is executed. If you have not run that script yet, then you may need to create it yourself. + + The file is located here: ``~/.rocoto//rocotorc``. Here is a sample working version of this file: + +.. code:: + + # This "---" is the required first line of the file + --- + :DatabaseType: SQLite3 + :BatchQueueServer: false + :WorkflowDocType: XML + :DatabaseServer: true + :WorkflowIOServer: true + :MaxUnknowns: 3 + :MaxLogDays: 7 + :AutoVacuum: true + :VacuumPurgeDays: 30 + :SubmitThreads: 8 + :JobQueueTimeout: 45 + :JobAcctTimeout: 45 diff --git a/workflow/rocoto/workflow_xml.py b/workflow/rocoto/workflow_xml.py index 281e2506267..ee9ad907649 100644 --- a/workflow/rocoto/workflow_xml.py +++ b/workflow/rocoto/workflow_xml.py @@ -245,7 +245,7 @@ def _check_rocotorc(self): raise FileNotFoundError( "Could not find the rocotorc file!\n" f"Please create '{rocotorc_file}' following the documentation at" "\n" - "https://global-workflow.readthedocs.io/en/latest/configure.html" + "https://global-workflow.readthedocs.io/en/latest/start.html#set-up-your-experiment-cron-or-scron" ) with open(rocotorc_file) as rc_f: @@ -253,5 +253,5 @@ def _check_rocotorc(self): raise ValueError( f"':BatchQueueServer: false' should be written to {rocotorc_file}, but it is not!" "\n" "Please follow the documentation guide here:\n" - "https://global-workflow.readthedocs.io/en/latest/configure.html" + "https://global-workflow.readthedocs.io/en/latest/start.html#set-up-your-experiment-cron-or-scron" )