Installation

Python version support

Officially Python 3.6 and above

Installing PSOpt

Installing from PyPI

PSOpt can be installed via pip from PyPI.

pip install psopt

Installing from source

Clone the repository via:

git clone https://github.com/artur-deluca/psopt/ --depth=1

Activate your virtual environment and run:

python setup.py install
# or alternatively
pip install -e .

If you wish to install the development dependencies, run:

python setup.py build
# or alternatively
pip install -e.[all]

See the Contributing Guide for further information on contributing

Running the test suite

To run the tests written for psopt, make sure you have pytest installed in your venv. Additionally, if you wish to run coverage analysis as well, make sure to have pytest-cov installed as well.

# to simply execute the tests run:
pytest
# to run coverage as well run:
pytest --cov=psopt
# or alternatively:
make test

Dependencies

Package	Minimum supported version
NumPy	1.13.3
dill	0.3.0
multiprocess	0.70.8

Note

As of today, psopt uses dill and multiprocess as a workaround to deal with pickling issues on the standard multiprocessing Python library.