Metadata-Version: 2.1
Name: cfsp
Version: 0.1.3
Summary: The cloudFPGA Support Package
Home-page: https://github.com/cloudFPGA/cfsp
Author: Dionysios Diamantopoulos
Author-email: did@zurich.ibm.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/cloudFPGA/cfsp/issues
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE

# cFSP

This is the **cloudFPGA Support Package (cFSP)** for the [cloudFPGA project](https://www.zurich.ibm.com/cci/cloudFPGA/).

## Requirements

Python 3.6+


## Installation

You can install `cfsp` system-wide through `pip install cfsp`, or user-wide through `pip install -u cfsp`.

It is advised though to do it in an isolated Python environment, e.g. through [virtualenv](https://virtualenv.pypa.io/):

```
virtualenv -p /usr/bin/python3.6 cfenv
source cfenv/bin/activate
pip install --upgrade pip
pip install cfsp
```

## Usage

Please check the [online documentation](https://cloudfpga.github.io/Doc/pages/CFSPHERE/cfsp.html).

## Development
```bash
git clone git@github.com:cloudFPGA/cFSP.git
cd cFSP
make env
source venv/bin/activate
<add your changes>  (do not forget to increase the `version="x.y.z"` in `setup.py`)
git commit -am "My changes for version x.y.z"
git push
make dist
make upload
```


