Skip to content

ukaea/PyVMCON

Repository files navigation

PyVMCON

License: MIT Testing Workflow

A Python implementation of the VMCON nonlinear constrained optimiser.

Installation

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

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.

Testing

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.

License

PyVMCON is provided under the MIT license, please see the LICENSE file for full details.

Copyright (c) 2023-present UK Atomic Energy Authority

About

Python implementation of the VMCON non-linear constrained optimiser.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages