Getting started

Download

PSyclone autodiff module is hosted on GitHub: https://github.com/JulienRemy/PSyclone/tree/automatic_differentiation.

It is currently an experimental protoype.

The latest version is the automatic_differentiation branch.

To download it, clone the repository using

$ git clone https://github.com/JulienRemy/PSyclone.git

Environment and dependencies

Please follow the instructions regarding environments and dependencies at https://psyclone.readthedocs.io/en/stable/getting_going.html.

This module also requires NumPy, which can be installed using pip:

$ pip install numpy

The tutorials also require Jupyter Notebook, which can be installed using pip:

$ pip install jupyter

Installing

PSyclone and its autodiff module can then be installed using pip:

$ cd <PSYCLONE_HOME>
$ pip install [--user] .

or using setup.py:

$ cd <PSYCLONE_HOME>
$ python setup.py install

Tutorial

See the src/psyclone/autodiff/tutorials/ directory for a Jupyter Notebook tutorial detailling the use of the module in reverse-mode.

To open it using Jupyter Notebook:

$ jupyter-notebook tuto1.ipynb