Metadata-Version: 2.1
Name: pyaccelerator
Version: 0.1.5
Summary: Accelerator building blocks.
Home-page: https://github.com/loiccoyle/pyaccelerator
License: MIT
Author: Loic Coyle
Author-email: loic.coyle <loic.coyle@hotmail.fr
Requires-Python: >=3.6,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Provides-Extra: docs
Requires-Dist: m2r2 (>=0.2.5,<0.3.0); extra == "docs"
Requires-Dist: matplotlib (==3.1.0)
Requires-Dist: numpy (>=1.19.0,<2.0.0)
Requires-Dist: scipy (>=1.5.2,<2.0.0)
Requires-Dist: sphinx (<3.3.0); extra == "docs"
Requires-Dist: sphinx-autoapi (>=1.5.0,<2.0.0); extra == "docs"
Requires-Dist: sphinx-rtd-theme (>=0.5.0,<0.6.0); extra == "docs"
Project-URL: Repository, https://github.com/loiccoyle/pyaccelerator
Description-Content-Type: text/markdown

# pyaccelerator

[![Tests](https://github.com/loiccoyle/accelerator/workflows/tests/badge.svg)](https://github.com/loiccoyle/accelerator/actions?query=workflow%3Atests)
[![Documentation Status](https://readthedocs.org/projects/pyaccelerator/badge/?version=latest)](https://pyaccelerator.readthedocs.io/en/latest/?badge=latest)
[![pypi](https://img.shields.io/pypi/v/pyaccelerator)](https://pypi.org/project/pyaccelerator/)

Python package to build simple toy accelerators.

# Dependencies:
  * `numpy`
  * `matplotlib`
  * `scipy`

# Installation:

```sh
pip install pyaccelerator
```

It usualy a good idea to use a [virtual environment](https://docs.python.org/3/tutorial/venv.html). To create a virtual environment in the `venv` folder (assuming python3):
```sh
python -m venv venv
```

To activate the virtual environment:
```sh
source venv/bin/activate
```

Proceed with the installation to install in the virtual environment.

To deactivate the virtual environment:
```sh
deactivate
```

# Usage:
See the `notebooks` folder for some examples.

