| Name | PyVMCON JSON |
| Version |
2.1.2
JSON |
| download |
| home_page | |
| Summary | Python implementation of the VMCON non-linear constrained optimiser. |
| upload_time | 2023-11-22 11:18:27 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 UK Atomic Energy Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
vmcon
optimisation
non-linear constrained optimisation
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyVMCON
[](https://opensource.org/licenses/MIT)
[](https://github.com/ukaea/PyVMCON/actions/workflows/tests.yml)
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**](https://ukaea.github.io/PyVMCON/). 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
Raw data
{
"_id": null,
"home_page": "",
"name": "PyVMCON",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "vmcon,optimisation,non-linear constrained optimisation",
"author": "",
"author_email": "Timothy Nunn <timothy.nunn@ukaea.uk>",
"download_url": "https://files.pythonhosted.org/packages/82/82/681acf7c6de50e6b79118d61b5251d52e564603526ca2a99fa94f8496450/PyVMCON-2.1.2.tar.gz",
"platform": null,
"description": "# PyVMCON\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/ukaea/PyVMCON/actions/workflows/tests.yml)\n\nA Python implementation of the VMCON nonlinear constrained optimiser.\n\n## Installation\nPyVMCON can be installed from PyPI via:\n\n```\npip install PyVMCON\n```\n\nOr installed from source:\n\n```\ngit clone https://github.com/ukaea/PyVMCON.git\ncd PyVMCON\npip install .\n```\n\n## Testing\nTests 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.\n\n## Documentation\nDocumentation for the VMCON algorithm and PyVMCON API/use can be found on our [**GitHub pages**](https://ukaea.github.io/PyVMCON/). The documentation includes references to the VMCON paper and other helpful resources.\n\n## License\nPyVMCON is provided under the MIT license, please see the LICENSE file for full details.\n\nCopyright (c) 2023 UK Atomic Energy Authority\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 UK Atomic Energy Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python implementation of the VMCON non-linear constrained optimiser.",
"version": "2.1.2",
"project_urls": {
"Documentation": "https://ukaea.github.io/PyVMCON/",
"Source": "https://github.com/ukaea/PyVMCON"
},
"split_keywords": [
"vmcon",
"optimisation",
"non-linear constrained optimisation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d12d018ef54468e5e9d20f42098bcd3b44c0de3609f9e495ddc7ebd77dca13d",
"md5": "4d1ed9f658f1081e983e5929b1b5210e",
"sha256": "849e6d5fad0a562093a4cccd37643221e1ffe0425bbcf714d134b5a42a952138"
},
"downloads": -1,
"filename": "PyVMCON-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d1ed9f658f1081e983e5929b1b5210e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9892,
"upload_time": "2023-11-22T11:18:26",
"upload_time_iso_8601": "2023-11-22T11:18:26.496670Z",
"url": "https://files.pythonhosted.org/packages/9d/12/d018ef54468e5e9d20f42098bcd3b44c0de3609f9e495ddc7ebd77dca13d/PyVMCON-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8282681acf7c6de50e6b79118d61b5251d52e564603526ca2a99fa94f8496450",
"md5": "7d825a6cd75f67be1c0529ed0d47347e",
"sha256": "54121673a90619703a186d4152a434e6dd7f41ac7ec0ef31fe20dff0f7ddb7cc"
},
"downloads": -1,
"filename": "PyVMCON-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "7d825a6cd75f67be1c0529ed0d47347e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 9759,
"upload_time": "2023-11-22T11:18:27",
"upload_time_iso_8601": "2023-11-22T11:18:27.736730Z",
"url": "https://files.pythonhosted.org/packages/82/82/681acf7c6de50e6b79118d61b5251d52e564603526ca2a99fa94f8496450/PyVMCON-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-22 11:18:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ukaea",
"github_project": "PyVMCON",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyvmcon"
}
