docs: create quickrun execution page

This commit is contained in:
richard gowers
2024-04-05 15:14:49 +01:00
committed by Richard Gowers
parent 4c4ce04d60
commit aca53b1d89
4 changed files with 19 additions and 13 deletions

View File

@@ -1,5 +1,7 @@
Protocols and the Execution Model
=================================
.. _userguide_execution_theory:
Protocols and the Execution Model Theory
========================================
Protocols in OpenFE are built on a flexible execution model.
Result objects are shaped by this model, and therefore some basic

View File

@@ -1,17 +1,14 @@
.. _userguide_execution:
Execution
---------
=========
Given a :class:`.Transformation`, the easiest way to run it is to use the
:func:`.execute_DAG` method. This will take the `.Transformation` object
and execute its `.ProtocolUnit` instances serially. Once complete it will
return a :class:`.ProtocolDAGResult`. Multiple ProtocolDAGResults from a given
transformation can be analyzed together with :meth:`.Protocol.gather` to
create a :class:`.ProtocolResult`.
.. TODO: add information about failures etc...
With a :class:`.Transformation` defined, the next step is to execute this.
The easiest way to run it is to use the :ref:`quickrun CLI tool <userguide_quickrun>`.
More advanced options are available through first considering the
:ref:`theory of the execution model<userguide_execution_theory>`
then :ref:`reading on the available Python functions<reference_execution>`.
.. toctree::
execution
quickrun_execution
execution_theory

View File

@@ -0,0 +1,5 @@
.. _userguide_quickrun:
Execution with Quickrun
=======================

View File

@@ -1,3 +1,5 @@
.. _reference_execution:
Defining and Executing Simulations
==================================