| Name | gana JSON |
| Version |
1.0.3
JSON |
| download |
| home_page | None |
| Summary | A barebones mathematical programming package |
| upload_time | 2025-10-20 17:13:38 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License
Copyright (c) 2025 Rahul Kakodkar
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 |
modeling
optimization
programming
aml
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://github.com/cacodcar/gana/raw/main/docs/_static/ganalogo.jpg" width="75%">
</p>
[](https://gana.readthedocs.io/en/latest/)
[](https://pypi.org/project/gana)
[](https://pepy.tech/project/gana)
[](https://github.com/cacodcar/gana/actions/workflows/python-package.yml)
Gana is an Algebraic Modeling Language (AML) for Multiscale Modeling and Optimization.
Generated programs (```Prg```) can be subclasses of Multiparametric Mixed Integer Linear Programming (mpMILP).
# Features
Gana supports:
- mutable elements, allowing constraints/functions to be updated dynamically
- multiparametric as well as mixed integer programming
- formulation in both matrix form and set-based mathematical program
Moreover, Gana uses a simple format to write constraints/functions.
# Elements
Programs in Gana are written using element sets, namely:
1. ```I``` - index
2. ```V``` - variable
3. ```P``` - parameter
4. ```T``` - parametric variable
# Solvers
The list of natively supported solvers are:
1. [PPOPT](https://github.com/TAMUparametric/PPOPT) for multiparametric programming (mp)
2. [Gurobi](https://www.gurobi.com/) for Mixed Integer Programming (MIP)
Programs can, however, be exported as a [.mps](https://www.ibm.com/docs/en/icos/22.1.2?topic=formats-working-mps-files) or [.lp](https://www.ibm.com/docs/en/icos/22.1.2?topic=formats-working-lp-files) file and passed to most solvers.
# Illustration
Gana is best run in [Jupyter](https://jupyter.org/) as notebook (.ipynb) files,
where programs can be visualized as canonical mathematical programs using set-notation.
Additionally, matrices can be exported.
# Purpose
Gana was developed to enable certain functionalities in [energia (py)](https://energiapy.readthedocs.io/en/latest/). Both were developed as PhD projects and have ample room for improvement. So please reach out to me on cacodcar@gmail.com with suggestions and such.
<!--
or
Matrices can be generated to represent:
LHS Parameter coefficient of variables in constraints:
1. A - all
2. G - inequality
3. H - equality
4. NN - nonnegativity
RHS parameters in constraints:
1. B
RHS Parameter coefficient of parametric variables in constraints:
1. F
Bounds of the parametric variables:
1. CRa - RHS coefficients
2. CRb - Bound (upper or lower) -->
Raw data
{
"_id": null,
"home_page": null,
"name": "gana",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Rahul Kakodkar <cacodcar@gmail.com>",
"keywords": "modeling, optimization, programming, aml",
"author": null,
"author_email": "Rahul Kakodkar <cacodcar@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/85/1b/cd88bbbe25487006782f13c114335353e08eee5177ac11f3ce14e75e37af/gana-1.0.3.tar.gz",
"platform": null,
"description": "\r\n<p align=\"center\">\r\n <img src=\"https://github.com/cacodcar/gana/raw/main/docs/_static/ganalogo.jpg\" width=\"75%\">\r\n</p>\r\n\r\n\r\n[](https://gana.readthedocs.io/en/latest/)\r\n[](https://pypi.org/project/gana)\r\n[](https://pepy.tech/project/gana)\r\n[](https://github.com/cacodcar/gana/actions/workflows/python-package.yml)\r\n\r\n\r\nGana is an Algebraic Modeling Language (AML) for Multiscale Modeling and Optimization. \r\nGenerated programs (```Prg```) can be subclasses of Multiparametric Mixed Integer Linear Programming (mpMILP). \r\n\r\n# Features \r\n\r\nGana supports:\r\n\r\n- mutable elements, allowing constraints/functions to be updated dynamically\r\n- multiparametric as well as mixed integer programming\r\n- formulation in both matrix form and set-based mathematical program \r\n\r\nMoreover, Gana uses a simple format to write constraints/functions. \r\n\r\n# Elements\r\n\r\nPrograms in Gana are written using element sets, namely:\r\n\r\n1. ```I``` - index \r\n2. ```V``` - variable\r\n3. ```P``` - parameter \r\n4. ```T``` - parametric variable\r\n \r\n\r\n# Solvers\r\n\r\nThe list of natively supported solvers are:\r\n\r\n1. [PPOPT](https://github.com/TAMUparametric/PPOPT) for multiparametric programming (mp)\r\n2. [Gurobi](https://www.gurobi.com/) for Mixed Integer Programming (MIP)\r\nPrograms can, however, be exported as a [.mps](https://www.ibm.com/docs/en/icos/22.1.2?topic=formats-working-mps-files) or [.lp](https://www.ibm.com/docs/en/icos/22.1.2?topic=formats-working-lp-files) file and passed to most solvers.\r\n\r\n\r\n# Illustration\r\n\r\nGana is best run in [Jupyter](https://jupyter.org/) as notebook (.ipynb) files, \r\nwhere programs can be visualized as canonical mathematical programs using set-notation.\r\n\r\nAdditionally, matrices can be exported. \r\n\r\n# Purpose\r\n\r\nGana was developed to enable certain functionalities in [energia (py)](https://energiapy.readthedocs.io/en/latest/). Both were developed as PhD projects and have ample room for improvement. So please reach out to me on cacodcar@gmail.com with suggestions and such. \r\n\r\n<!-- \r\nor \r\n\r\nMatrices can be generated to represent: \r\n\r\nLHS Parameter coefficient of variables in constraints: \r\n 1. A - all\r\n 2. G - inequality \r\n 3. H - equality\r\n 4. NN - nonnegativity\r\n\r\nRHS parameters in constraints:\r\n 1. B \r\n\r\nRHS Parameter coefficient of parametric variables in constraints:\r\n 1. F \r\n\r\nBounds of the parametric variables:\r\n 1. CRa - RHS coefficients\r\n 2. CRb - Bound (upper or lower) -->\r\n\r\n\r\n\r\n\r\n\r\n",
"bugtrack_url": null,
"license": "MIT License\r\n \r\n Copyright (c) 2025 Rahul Kakodkar\r\n \r\n Permission is hereby granted, free of charge, to any person obtaining a copy\r\n of this software and associated documentation files (the \"Software\"), to deal\r\n in the Software without restriction, including without limitation the rights\r\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\r\n copies of the Software, and to permit persons to whom the Software is\r\n furnished to do so, subject to the following conditions:\r\n \r\n The above copyright notice and this permission notice shall be included in all\r\n copies or substantial portions of the Software.\r\n \r\n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\n SOFTWARE.\r\n ",
"summary": "A barebones mathematical programming package",
"version": "1.0.3",
"project_urls": {
"Homepage": "https://github.com/cacodcar/gana",
"Issues": "https://github.com/cacodcar/gana/issues"
},
"split_keywords": [
"modeling",
" optimization",
" programming",
" aml"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f47ce779c04ba823cc35c41e39b992452f4eacf5ec6ad8a488c993525df3d8a9",
"md5": "41d91fe19b76d08d0dfee8d095871255",
"sha256": "ba4f0815a552c2ab728ded5d45fa2b5dc533761ddad81b9521f85e47563f5512"
},
"downloads": -1,
"filename": "gana-1.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "41d91fe19b76d08d0dfee8d095871255",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 67256,
"upload_time": "2025-10-20T17:13:37",
"upload_time_iso_8601": "2025-10-20T17:13:37.530827Z",
"url": "https://files.pythonhosted.org/packages/f4/7c/e779c04ba823cc35c41e39b992452f4eacf5ec6ad8a488c993525df3d8a9/gana-1.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "851bcd88bbbe25487006782f13c114335353e08eee5177ac11f3ce14e75e37af",
"md5": "1bb2b10f8d347de7a0dda177dab396a1",
"sha256": "006dd639b819be3fec59df4696bff1997dd83b920a4d6f23c0ddf60e1fbd1854"
},
"downloads": -1,
"filename": "gana-1.0.3.tar.gz",
"has_sig": false,
"md5_digest": "1bb2b10f8d347de7a0dda177dab396a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 60288,
"upload_time": "2025-10-20T17:13:38",
"upload_time_iso_8601": "2025-10-20T17:13:38.711988Z",
"url": "https://files.pythonhosted.org/packages/85/1b/cd88bbbe25487006782f13c114335353e08eee5177ac11f3ce14e75e37af/gana-1.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 17:13:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cacodcar",
"github_project": "gana",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "gana"
}
