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 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.1.2.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

PyVMCON-2.1.2-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

Details for the file PyVMCON-2.1.2.tar.gz.

File metadata

  • Download URL: PyVMCON-2.1.2.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for PyVMCON-2.1.2.tar.gz
Algorithm Hash digest
SHA256 54121673a90619703a186d4152a434e6dd7f41ac7ec0ef31fe20dff0f7ddb7cc
MD5 7d825a6cd75f67be1c0529ed0d47347e
BLAKE2b-256 8282681acf7c6de50e6b79118d61b5251d52e564603526ca2a99fa94f8496450

See more details on using hashes here.

File details

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

File metadata

  • Download URL: PyVMCON-2.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for PyVMCON-2.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 849e6d5fad0a562093a4cccd37643221e1ffe0425bbcf714d134b5a42a952138
MD5 4d1ed9f658f1081e983e5929b1b5210e
BLAKE2b-256 9d12d018ef54468e5e9d20f42098bcd3b44c0de3609f9e495ddc7ebd77dca13d

See more details on using hashes here.

Supported by

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