Skip to content

Commit

Permalink
renamed tutorials to give natural order
Browse files Browse the repository at this point in the history
  • Loading branch information
tclose committed Jan 7, 2025
1 parent 83cbbb6 commit e6c488f
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 10 deletions.
16 changes: 8 additions & 8 deletions new-docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ multiparameter map-reduce operations, in Python code and the use of a global cac

Pydra's key features are:

* Combine diverse tasks, implemented in `Python functions <./tutorial/python.html>`__ or stand-alone `shell commands <./tutorial/shell.html>`__, into coherent `workflows <./tutorial/workflow.html>`__
* Combine diverse tasks, implemented in `Python functions <./tutorial/3-python.html>`__ or stand-alone `shell commands <./tutorial/4-shell.html>`__, into coherent `workflows <./tutorial/5-workflow.html>`__
* Map-reduce like semantics (see :ref:`Splitting and combining`)
* Dynamic workflow construction using Python code (see :ref:`Dynamic construction`)
* Modular execution systems for varied deployment on cloud, HPC, etc... (see `Execution options <./tutorial/advanced-execution.html>`__)
* Modular execution systems for varied deployment on cloud, HPC, etc... (see `Execution options <./tutorial/2-advanced-execution.html>`__)
* Support for the execution of tasks in containerized environments (see :ref:`Containers and environments`)
* Global caching to reduce recomputation (see :ref:`Hashing and caching`)
* Support for strong type-checking, including file types, at workflow construction time (see :ref:`Typing and file-formats`)
Expand Down Expand Up @@ -112,18 +112,18 @@ See the full reference documentation for Pydra
:caption: Tutorials: Execution
:hidden:

tutorial/getting-started
tutorial/advanced-execution
tutorial/1-getting-started
tutorial/2-advanced-execution

.. toctree::
:maxdepth: 2
:caption: Tutorials: Design
:hidden:

tutorial/python
tutorial/shell
tutorial/workflow
tutorial/canonical-form
tutorial/3-python
tutorial/4-shell
tutorial/5-workflow
tutorial/6-canonical-form


.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"inputs then the location of its output directory will also be the same, and the outputs\n",
"generated by the previous run are reused.\n",
"\n",
"For example, using the MrGrid example from the [Getting Started Tutorial](./getting-started.html)\n"
"For example, using the MrGrid example from the [Getting Started Tutorial](./1-getting-started.html)\n"
]
},
{
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"`pydra.design.*.define` decorators/functions are translated to\n",
"[dataclasses](https://docs.python.org/3/library/dataclasses.html) by the\n",
"[Attrs](https://www.attrs.org/en/stable/). While the more compact syntax described\n",
"in the [Python-tasks](./python.html), [Shell-tasks](./shell.html) and [Workflow](./workflow.html)\n",
"in the [Python-tasks](./3-python.html), [Shell-tasks](./4-shell.html) and [Workflow](./5-workflow.html)\n",
"tutorials is convenient when designing tasks for specific use cases, it is too magical\n",
"for linters follow. Therefore, when designing task definitions to be used by third\n",
"parties (e.g. `pydra-fsl`, `pydra-ants`) it is recommended to favour the, more\n",
Expand Down

0 comments on commit e6c488f

Please sign in to comment.