Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.23 KB

README.md

File metadata and controls

21 lines (14 loc) · 1.23 KB

MyPyOpt

Python version of my simple optimization app from school

Documentation

Documentation is hosted on ReadTheDocs.
The docs are completely bare right now.
To build the documentation, enter the docs/ subdirectory and execute make html; then open /docs/_build/html/index.html to see the documentation. In addition to that documentation, the repo contains a set of demos to show off how the library can be used.

Testing

Flake8 Run Tests

The source is tested using the python unittest framework. To execute all the unit tests, just run nosetests from the project root.

Installation

GitHub Actions is used to package up each release into a wheel and post on PyPi here: https://pypi.org/project/my-py-opt/. Therefore it can be installed using pip install my-py-opt.