{"id":15992989,"url":"https://github.com/timjentzsch/optiframe","last_synced_at":"2025-03-17T19:32:03.636Z","repository":{"id":149897439,"uuid":"612964271","full_name":"TimJentzsch/optiframe","owner":"TimJentzsch","description":"A modular framework for mixed integer programming.","archived":false,"fork":false,"pushed_at":"2023-05-05T17:05:55.000Z","size":87,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-08T06:31:10.930Z","etag":null,"topics":["framework","mixed-integer-programming","operations-research","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TimJentzsch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-12T14:07:06.000Z","updated_at":"2023-12-26T11:26:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"4d48da8a-9ce3-47f1-862e-738eeba274b9","html_url":"https://github.com/TimJentzsch/optiframe","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimJentzsch%2Foptiframe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimJentzsch%2Foptiframe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimJentzsch%2Foptiframe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TimJentzsch%2Foptiframe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TimJentzsch","download_url":"https://codeload.github.com/TimJentzsch/optiframe/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243878478,"owners_count":20362433,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","mixed-integer-programming","operations-research","python"],"created_at":"2024-10-08T06:42:15.474Z","updated_at":"2025-03-17T19:32:03.627Z","avatar_url":"https://github.com/TimJentzsch.png","language":"Python","readme":"# Optiframe [![PyPI Version](https://img.shields.io/pypi/v/optiframe)](https://pypi.org/project/optiframe/) [![License](https://img.shields.io/pypi/l/optiframe)](LICENSE)\n\nOptiframe is an **opti**mization **frame**work for writing mixed integer programs (MIPs).\n\nIt allows you to structure your MIPs in a way that allows clear separation of concerns,\nhigh modularity and testability.\n\n## Core Concepts\n\n- The optimization process is divided into multiple **steps** which are clearly separated:\n  1. **Validation** allows you to validate the input data.\n  2. **Pre-processing** allows you to optimize the provided data to reduce the size of the final model.\n  3. **MIP building** allows you to modify the MIP to define the optimization problem.\n  4. **Solving** is a pre-defined step that obtains an optimal solution for the problem.\n  5. **Solution extraction** allows you to process the variable values of the solution into something more meaningful.\n- **Tasks** are the core components that allow you to implement functionality for each step.\n  - The constructor of a task allows you to define *dependencies* for that task,\n    which are automatically injected by the optimizer based on their type annotation.\n  - The **execute** method allows you to implement the functionality.\n    It may return data which can then be used by other tasks as a dependency.\n- **Modules** combine tasks that belong together.\n    Each module must contain a task for building the MIP and can additionally contain tasks\n    for validation, pre-processing and solution extraction.\n    The modules are what makes Optiframe so extendable:\n    You can define extensions of a problem in a separate module and only include it if needed.\n- The **optimizer** allows you to configure the packages that you need.\n    Afterwards, you can initialize it with the instance data and then solve the optimization problem.\n\n## Installation \u0026 Usage\n\n```cli\npip install optiframe\n```\n\nTake a look at the `examples` folder for examples on how to use Optiframe!\n\n## License\n\nThis project is available under the terms of the [MIT license](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimjentzsch%2Foptiframe","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimjentzsch%2Foptiframe","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimjentzsch%2Foptiframe/lists"}