Skip to content

Commit 923ac11

Browse files
committed
fixed up README
1 parent a41d30d commit 923ac11

File tree

1 file changed

+46
-27
lines changed

1 file changed

+46
-27
lines changed

README.rst

Lines changed: 46 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
1-
|GHAction| |CircleCI| |codecov|
1+
|CI/CD| |codecov| |Python Versions| |PyPI| |Docs|
22

33
|Pydralogo|
44

5-
.. |Pydralogo| image:: https://raw.githubusercontent.com/nipype/pydra/master/docs/logo/pydra_logo.jpg
6-
:width: 200px
7-
:alt: pydra logo
8-
9-
.. |GHAction| image:: https://github.com/nipype/pydra/workflows/Pydra/badge.svg
10-
:alt: GitHub Actions CI
11-
:target: https://github.com/nipype/Pydra/actions
12-
13-
.. |CircleCI| image:: https://circleci.com/gh/nipype/pydra.svg?style=svg
14-
:alt: CircleCI
15-
16-
.. |codecov| image:: https://codecov.io/gh/nipype/pydra/branch/master/graph/badge.svg
17-
:alt: codecov
18-
195
======================
206
Pydra: Dataflow Engine
217
======================
@@ -30,11 +16,12 @@ construction, manipulation, and distributed execution.
3016

3117
Feature list:
3218
=============
33-
1. Python 3.7+ using type annotation and `attrs <https://www.attrs.org/en/stable/>`_
19+
1. Python 3.11+ using type annotation and `attrs <https://www.attrs.org/en/stable/>`_
3420
2. Composable dataflows with simple node semantics. A dataflow can be a node of another dataflow.
3521
3. `splitter` and `combiner` provides many ways of compressing complex loop semantics
3622
4. Cached execution with support for a global cache across dataflows and users
37-
5. Distributed execution, presently via ConcurrentFutures, SLURM, and Dask (this is an experimental implementation with limited testing)
23+
5. Distributed execution, presently via ConcurrentFutures, SLURM and SGE, with support
24+
for PS/IJ and Dask available via plugins
3825

3926
`API Documentation <https://nipype.github.io/pydra/>`_
4027

@@ -65,14 +52,32 @@ Note that installation fails with older versions of pip on Windows. Upgrade pip
6552

6653
::
6754

68-
pip install –upgrade pip
55+
pip install -–upgrade pip
6956
pip install pydra
7057

7158

59+
If you want to install plugins for psij or dask you can by installing the relevant
60+
plugin packages
61+
62+
::
63+
64+
pip install pydra-workers-psij
65+
pip install pydra-workers-dask
66+
67+
68+
Task implementations for various toolkits and workflows are available in task plugins,
69+
which can be installed similarly
70+
71+
::
72+
73+
pip install pydra-tasks-mrtrix3
74+
pip install pydra-tasks-fsl
75+
76+
7277
Developer installation
7378
======================
7479

75-
Pydra requires Python 3.7+. To install in developer mode:
80+
Pydra requires Python 3.11+. To install in developer mode:
7681

7782
::
7883

@@ -88,19 +93,33 @@ In order to run pydra's test locally:
8893
pytest -vs pydra
8994

9095

91-
If you want to test execution with Dask:
96+
It is also useful to install pre-commit:
9297

9398
::
9499

95-
git clone [email protected]:nipype/pydra.git
96-
cd pydra
97-
pip install -e ".[dask]"
100+
pip install pre-commit
101+
pre-commit
98102

99103

104+
.. |Pydralogo| image:: https://raw.githubusercontent.com/nipype/pydra/main/docs/source/_static/logo/pydra_logo.jpg
105+
:width: 200px
106+
:alt: pydra logo
100107

101-
It is also useful to install pre-commit:
108+
.. |CI/CD| image:: https://github.com/nipype/pydra/actions/workflows/ci-cd.yml/badge.svg
109+
:alt: CI/CD
110+
:target: https://github.com/nipype/pydra/actions/workflows/ci-cd.yml
102111

103-
::
112+
.. |codecov| image:: https://codecov.io/gh/nipype/pydra/branch/main/graph/badge.svg
113+
:alt: codecov
104114

105-
pip install pre-commit
106-
pre-commit
115+
.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/pydra.svg
116+
:alt: Supported Python versions
117+
:target: https://pypi.python.org/pypi/pydra
118+
119+
.. |PyPI| image:: https://img.shields.io/pypi/v/pydra.svg
120+
:alt: PyPI
121+
:target: https://pypi.python.org/pypi/pydra
122+
123+
.. |Docs| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
124+
:alt: Documentation Status
125+
:target: https://nipype.github.io/pydra

0 commit comments

Comments
 (0)