A Python implementation of the VMCON nonlinear constrained optimiser.
PyVMCON can be installed from PyPI via:
pip install PyVMCON
Or installed from source:
git clone https://github.com/ukaea/PyVMCON.git
cd PyVMCON
pip install .
Documentation for the VMCON algorithm and PyVMCON API/use can be found on our GitHub pages. The documentation includes references to the VMCON paper and other helpful resources.
If you use PyVMCON in your work, please cite it using the "Cite this repository" link in the "About" section of the repository. This will cite the latest version of PyVMCON, if you are using a different release, please find the appropriate DOI on PyVMCON's Zenodo page.
Tests can be run by installing the optional test dependencies pip install 'PyVMCON[test]' and then running pytest tests/. The tests check the examples from the original VMCON paper are replicated.
PyVMCON is provided under the MIT license, please see the LICENSE file for full details.
Copyright (c) 2023-present UK Atomic Energy Authority