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.0.0.tar.gz (9.4 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.0.0-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for PyVMCON-2.0.0.tar.gz
Algorithm Hash digest
SHA256 61540f07f347c0859e585476350b4cda0160418ba28e4faabf13bd037f7c0f55
MD5 5876b3a701df499e1fc912fcddc2d5e7
BLAKE2b-256 17262404042735690228071a630eb3aa173c7cdb776c28bf62290b16ee9ac464

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for PyVMCON-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b4a8029c5431f445dd222e49c2c267ba554e7a7d5fe6976b887cbc0b27440ce
MD5 2406a8fe8ae67fdef5af357a7ace5e7a
BLAKE2b-256 11dd9ba524cd67c290935b67763297b1a17994f89150ecddadc3bccf2d775df3

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