Skip to main content

Python implementation of the VMCON non-linear constrained optimiser.

Project description

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 .

Testing

Tests can be run using pytest tests/. The tests check the paper examples are replicated. In some cases (I believe due to the way the quadratic programming implementation differs) the values achieved are different to the paper, but still correct; such cases have been noted in the test file.

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.

License

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

Copyright (c) 2023-2024 UK Atomic Energy Authority

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyvmcon-2.2.2.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

PyVMCON-2.2.2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file pyvmcon-2.2.2.tar.gz.

File metadata

  • Download URL: pyvmcon-2.2.2.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for pyvmcon-2.2.2.tar.gz
Algorithm Hash digest
SHA256 bde4a76d76fd634b57f816b519a2dd8dcc8bab4b7ecc128503bf566646ba515d
MD5 3cc7da13085274432cb49ee314030c75
BLAKE2b-256 80e61e76fd65849a5e3caf1a7f94c4b234c45db61565cf10e5abbf40643a6c2d

See more details on using hashes here.

File details

Details for the file PyVMCON-2.2.2-py3-none-any.whl.

File metadata

  • Download URL: PyVMCON-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for PyVMCON-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 bc0392420c8b98c22e974bdeca1603969a536d756b9aa16ced3fdcf956517750
MD5 8d60d77c058461556bbf198b91b536df
BLAKE2b-256 b2b4bac9a6f394508b4a4bd1b475aa930c45c247fb5d41fc348d6713965888ea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page