Quickstart¶
To try Parsl now (without installing any code) experiment with our hosted tutorial notebooks.
Installation¶
Parsl is available on PyPI, but first make sure you have Python3.5+
>>> python3 --version
You’ll also need gcc to be installed in order to run Parsl.
$ gcc --version
Parsl has been tested on Linux and MacOS.
Note
As of Parsl v0.7.2 we are switching to an opt-in model for anonymous usage tracking. To help support the
Parsl project we request that users opt-in where possible by setting PARSL_TRACKING=true
in their environment
or by setting usage_tracking=True
in the configuration object (parsl.config.Config
). To read more about
what information is collected and how it is used see Usage statistics collection.
Installation using Pip¶
While pip
and pip3
can be used to install Parsl we suggest the following approach
for reliable installation when many Python environments are avaialble.
Install Parsl:
$ python3 -m pip install parsl
To update a previously installed parsl to a newer version, use: python3 -m pip install -U parsl
Install Jupyter for Tutorial notebooks:
$ python3 -m pip install jupyter
Note
For more detailed info on setting up Jupyter with Python3.5 go here
Installation using Conda¶
Install Conda and set up python3.6 following the instructions here:
$ conda create --name parsl_py36 python=3.6 $ source activate parsl_py36
Install Parsl:
$ python3 -m pip install parsl or $ conda config --add channels conda-forge $ conda install parsl
To update a previously installed parsl to a newer version, use: python3 -m pip install -U parsl
Installation of Optional Packages¶
Parsl supports several optional components that require additional module installations.
For example support for Amazon Web Services, Extreme Scale Executor etc require additional packages that
can be installed easily via pip
using a pip extras option.
Here’s a list of the components and their extras option:
- Amazon Web Services (Cloud) :
aws
- Google Cloud :
google_cloud
- Kubernetes :
kubernetes
- Extreme Scale Executor (Supercomputing) :
extreme_scale
- Logging monitoring data to a database:
monitoring
- Jetstream (NSF Cloud) :
jetstream
Optional extras can be installed using the following syntax:
$ python3 -m pip install parsl[<optional_package1>, <optional_package2>]
For Developers¶
Download Parsl:
$ git clone https://github.com/Parsl/parsl
Install:
$ cd parsl $ pip install . ( To install specific extra options from the source :) $ pip install .[<optional_pacakge1>...]
Use Parsl!
Requirements¶
Parsl requires the following:
- Python 3.5+
For testing:
- nose
- coverage
For building documentation:
- nbsphinx
- sphinx
- sphinx_rtd_theme