Skip to content

Commit d500d75

Browse files
matt-grahamtamuri
andauthored
Add note about behaviour of asserts in batch jobs (#1573)
* Add note about behaviour of asserts in batch jobs * Apply suggestions from code review Co-authored-by: Asif Tamuri <[email protected]> --------- Co-authored-by: Asif Tamuri <[email protected]>
1 parent ed8a131 commit d500d75

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/azure_batch.rst

+7
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,13 @@ Each of the subcommands of ``tlo`` has a ``--help`` flag for further information
9090
*Submit scenario to Azure Batch*::
9191

9292
tlo batch-submit src/scripts/dev/tlo_q1_demo.py
93+
94+
.. note:: **Behaviour of assert statements**
95+
96+
Scenario runs submitted with ``tlo batch-submit`` will by default run with any assert statements disabled.
97+
Typically, these are used for checking correctness of code in tests and local runs but as they add some overhead,
98+
we can get a useful speed-up by disabling them on longer jobs.
99+
To run jobs with assertions enabled pass the ``--asserts-on`` flag` to ``tlo batch-submit``.
93100

94101
*List jobs currently on Azure Batch where id contains "tamuri"*::
95102

0 commit comments

Comments
 (0)