Skip to content

Commit

Permalink
doc(update) [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
nipypebot committed May 30, 2024
0 parents commit 5ecb68c
Show file tree
Hide file tree
Showing 1,707 changed files with 217,506 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 542912f80ce34c063298eb7c8e368ec9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/api.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.audit.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.boutiques.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.core.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.environments.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.graph.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.helpers.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.helpers_file.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.run_pickled.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.specs.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.state.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.submitter.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.task.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.engine.workers.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.mark.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.mark.functions.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.tasks.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.hash.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.messenger.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.misc.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.profiler.doctree
Binary file not shown.
Binary file added .doctrees/api/pydra.utils.typing.doctree
Binary file not shown.
Binary file added .doctrees/changes.doctree
Binary file not shown.
Binary file added .doctrees/combiner.doctree
Binary file not shown.
Binary file added .doctrees/components.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/input_spec.doctree
Binary file not shown.
Binary file added .doctrees/output_spec.doctree
Binary file not shown.
Binary file added .doctrees/state.doctree
Binary file not shown.
Binary file added .doctrees/user_guide.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
4 changes: 4 additions & 0 deletions 0.21/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 542912f80ce34c063298eb7c8e368ec9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added 0.21/.doctrees/api.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.audit.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.boutiques.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.core.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.graph.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.helpers.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.specs.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.state.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.submitter.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.task.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.engine.workers.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.mark.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.mark.functions.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.tasks.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.utils.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.utils.messenger.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/api/pydra.utils.profiler.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/changes.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/combiner.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/components.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/environment.pickle
Binary file not shown.
Binary file added 0.21/.doctrees/index.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/input_spec.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/output_spec.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/state.doctree
Binary file not shown.
Binary file added 0.21/.doctrees/user_guide.doctree
Binary file not shown.
Empty file added 0.21/.nojekyll
Empty file.
Binary file added 0.21/_images/nd_spl_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 0.21/_images/nd_spl_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 0.21/_images/nd_spl_3_comb1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 0.21/_images/nd_spl_3_comb3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added 0.21/_images/nd_spl_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions 0.21/_sources/api.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Library API (application programmer interface)
==============================================

.. automodule:: pydra
:members:
:undoc-members:
:show-inheritance:

Subpackages
-----------

.. toctree::

api/pydra.engine
api/pydra.mark
api/pydra.tasks
api/pydra.utils
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.audit.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.audit module
=========================

.. automodule:: pydra.engine.audit
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.boutiques.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.boutiques module
=============================

.. automodule:: pydra.engine.boutiques
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.core.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.core module
========================

.. automodule:: pydra.engine.core
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.graph.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.graph module
=========================

.. automodule:: pydra.engine.graph
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.helpers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.helpers module
===========================

.. automodule:: pydra.engine.helpers
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.helpers_file.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.helpers\_file module
=================================

.. automodule:: pydra.engine.helpers_file
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.helpers_state.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.helpers\_state module
==================================

.. automodule:: pydra.engine.helpers_state
:members:
:undoc-members:
:show-inheritance:
26 changes: 26 additions & 0 deletions 0.21/_sources/api/pydra.engine.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
pydra.engine package
====================

.. automodule:: pydra.engine
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 1

pydra.engine.audit
pydra.engine.boutiques
pydra.engine.core
pydra.engine.graph
pydra.engine.helpers
pydra.engine.helpers_file
pydra.engine.helpers_state
pydra.engine.specs
pydra.engine.state
pydra.engine.submitter
pydra.engine.task
pydra.engine.workers
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.specs.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.specs module
=========================

.. automodule:: pydra.engine.specs
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.state.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.state module
=========================

.. automodule:: pydra.engine.state
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.submitter.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.submitter module
=============================

.. automodule:: pydra.engine.submitter
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.task.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.task module
========================

.. automodule:: pydra.engine.task
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.engine.workers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.engine.workers module
===========================

.. automodule:: pydra.engine.workers
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.mark.functions.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.mark.functions module
===========================

.. automodule:: pydra.mark.functions
:members:
:undoc-members:
:show-inheritance:
15 changes: 15 additions & 0 deletions 0.21/_sources/api/pydra.mark.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
pydra.mark package
==================

.. automodule:: pydra.mark
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 1

pydra.mark.functions
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.tasks.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.tasks package
===================

.. automodule:: pydra.tasks
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.utils.messenger.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.utils.messenger module
============================

.. automodule:: pydra.utils.messenger
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions 0.21/_sources/api/pydra.utils.profiler.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pydra.utils.profiler module
===========================

.. automodule:: pydra.utils.profiler
:members:
:undoc-members:
:show-inheritance:
16 changes: 16 additions & 0 deletions 0.21/_sources/api/pydra.utils.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
pydra.utils package
===================

.. automodule:: pydra.utils
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

.. toctree::
:maxdepth: 1

pydra.utils.messenger
pydra.utils.profiler
132 changes: 132 additions & 0 deletions 0.21/_sources/changes.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
Release Notes
=============

0.8.0
-----

* refactoring template formatting for ``input_spec``
* fixing issues with input fields with extension (and using them in templates)
* adding simple validators to input spec (using ``attr.validator``)
* adding ``create_dotfile`` for workflows, that creates graphs as dotfiles (can convert to other formats if dot available)
* adding a simple user guide with ``input_spec`` description
* expanding docstrings for ``State``, ``audit`` and ``messanger``
* updating syntax to newer python

0.7.0
-----

* refactoring the error handling by padra: improving raised errors, removing nodes from the workflow graph that can't be run
* refactoring of the ``input_spec``: adapting better to the nipype interfaces
* switching from ``pkg_resources.declare_namespace`` to the stdlib ``pkgutil.extend_path``
* moving ``readme`` to rst format


0.6.2
-----

* Use pkgutil to declare ``pydra.tasks`` as a namespace package, ensuring better support for
editable mode.

0.6.1
-----

* Add ``pydra.tasks`` namespace package to enable separate packages of ``Task``\s to be
installed into ``pydra.tasks``.
* Raise error when task or workflow name conflicts with names of attributes, methods, or
other tasks already added to workflow
* Mention ``requirements.txt`` in README

0.6
---

* removing the tutorial to a `separate repo <https://github.com/nipype/pydra-tutorial>`__
* adding windows tests to codecov
* accepting ``None`` as a valid output from a ``FunctionTask``, also for function that returns multiple values
* fixing slurm error files
* adding ``wf._connection`` to ``checksum``
* allowing for updates of ``wf._connections``
* editing output, so it works with ``numpy.arrays``
* removing ``to_job`` and pickling task instead (workers read the tasks and set the proper input, so the multiple copies of the input are not kept in the memory)
* adding standalone function ``load_and_run`` that can load and run a task from a pickle file
* removing ``create_pyscript`` and simplifying the slurm worker
* improving error reports in errors flies
* fixing ``make_class`` so the ``Output`` is properly formatted

0.5
---

* fixing ``hash_dir`` function
* adding ``get_available_cpus`` to get the number of CPUs available to the current process or available on the system
* adding simple implementation for ``BoshTask`` that uses boutiques descriptor
* adding azure to CI
* fixing code for windows
* etelementry updates
* adding more verbose output for task ``result`` - returns values or indices for input fields
* adding an experimental implementation of Dask Worker (limited testing with ci)

0.4
---

* reorganization of the ``State`` class, fixing small issues with the class
* fixing some paths issues on windows os
* adding osx and window sto the travis runs (right now allowing for failures for windows)
* adding ``PydraStateError`` for exception in the ``State`` class
* small fixes to the hashing functions, adding more tests
* adding ``hash_dir`` to calculate hash for ``Directory`` type

0.3.1
-----

* passing ``wf.cache_locations`` to the task
* using ``rerun`` from submitter to all task
* adding ``test_rerun`` and ``propagate_rerun`` for workflows
* fixing task with a full combiner
* adding ``cont_dim`` to specify dimensionality of the input variables (how much the input is nested)

0.3
---

* adding sphinx documentation
* moving from ``dataclasses`` to ``attrs``
* adding ``container`` flag to the ``ShellCommandTask``
* fixing ``cmdline``, ``command_args`` and ``container_args`` for tasks with states
* adding ``CONTRIBUTING.md``
* fixing hash calculations for inputs with a list of files
* using ``attr.NOTHING`` for input that is not set

0.2.2
-----

* supporting tuple as a single element of an input

0.2.1
-----

* fixing: nodes with states and input fields (from splitter) that are empty were failing

0.2
---

* big changes in ``ShellTask``, ``DockerTask`` and ``SingularityTask``
* customized input specification and output specification for ``Task``\s
* adding singularity checks to Travis CI
* binding all input files to the container
* changes in ``Workflow``
* passing all outputs to the next node: ``lzout.all_``
* fixing inner splitter
* allowing for ``splitter`` and ``combiner`` updates
* adding ``etelementry`` support

0.1
---

* Core dataflow creation and management API
* Distributed workers:
* concurrent futures
* SLURM
* Notebooks for Pydra concepts

0.0.1
-----

Initial Pydra Dataflow Engine release.
Loading

0 comments on commit 5ecb68c

Please sign in to comment.