Skip to content

Commit

Permalink
touch up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tclose committed Jan 6, 2025
1 parent ac7ab7f commit 7c47eef
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 12 deletions.
4 changes: 2 additions & 2 deletions new-docs/source/explanation/conditional-lazy.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Conditionals and lazy fields
============================
Dynamic workflow construction
=============================

Work in progress...
4 changes: 4 additions & 0 deletions new-docs/source/explanation/hashing-caching.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Hashing and caching
===================

Work in progress...
4 changes: 2 additions & 2 deletions new-docs/source/explanation/typing.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Typing, file-formats and hashing
================================
Typing and file-formats
=======================

Work in progress...
19 changes: 11 additions & 8 deletions new-docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,18 @@ Pydra helps build reproducible, scalable, reusable, and fully automated, provena
tracked scientific workflows that combine Python functions and shell commands.

The power of Pydra lies in ease of workflow creation and execution for complex
multiparameter map-reduce operations, and the use of global cache.
multiparameter map-reduce operations, and the use of global cache (see
:ref:`Design philosophy` for the rationale behind its design).

Pydra's key features are:
- Modular execution backends (see `Advanced execution <./tutorial/advanced-execution.html>`__)
- Map-reduce like semantics (see `Splitting and combining <./explanation/splitting-combining.html>`__)
- Global cache support to reduce recomputation (see `Hashing and caching <./explanation/hashing-caching.html>`__)
- Support for execution of Tasks in containerized environments (see `Environments <./explanation/environments.html>`__)
- Strong type-checking and type-hinting support (see `Typing <./explanation/typing.html>`__)

See :ref:`Design philosophy` for more an explanation of the design of Pydra.
* Map-reduce like semantics (see :ref:`Splitting and combining`)
* Dynamic workflow construction using Python code (see :ref:`Dynamic workflow construction`)
* Modular execution backends (see `Advanced execution <./tutorial/advanced-execution.html>`__)
* Global cache support to reduce recomputation (see :ref:`Hashing and caching`)
* Support for the execution of tasks in containerized environments (see :ref:`Containers and environments`)
* Strong type-checking and type-hinting support (see :ref:`Typing and file-formats`)


Installation
------------
Expand Down Expand Up @@ -113,11 +115,12 @@ Indices and tables

.. toctree::
:maxdepth: 2
:caption: In-depth
:caption: Explanation
:hidden:

explanation/design-approach
explanation/splitting-combining
explanation/hashing-caching
explanation/typing
explanation/conditional-lazy
explanation/environments
Expand Down

0 comments on commit 7c47eef

Please sign in to comment.