quicopt 0.1.0__tar.gz

quicopt-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   (c) 2026 Tim Bode, PGI-12, Forschungszentrum Jülich
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

quicopt-0.1.0/PKG-INFO

@@ -0,0 +1,124 @@
+Metadata-Version: 2.4
+Name: quicopt
+Version: 0.1.0
+Summary: Python client for the Quicopt service — author models, emit the Quicopt wire IR.
+Author-email: Tim Bode <9047234+timbode@users.noreply.github.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/timbode/quicopt-python
+Project-URL: Repository, https://github.com/timbode/quicopt-python
+Project-URL: Documentation, https://timbode.github.io/quicopt-python/
+Keywords: optimization,mathematical-programming,modeling,pyomo,quicopt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: pyomo
+Requires-Dist: pyomo>=6; extra == "pyomo"
+Provides-Extra: mathopt
+Requires-Dist: ortools>=9; extra == "mathopt"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Provides-Extra: docs
+Requires-Dist: mkdocs-material>=9; extra == "docs"
+Requires-Dist: mkdocstrings[python]>=0.24; extra == "docs"
+Requires-Dist: black; extra == "docs"
+Dynamic: license-file
+
+# quicopt
+
+The Python client for the Quicopt optimization service. Author a model in a Python
+modeling front-end (Pyomo, or OR-Tools MathOpt), convert it to Quicopt's wire IR, and
+emit the versioned, language-neutral bytes the service consumes.
+
+## Install
+
+```sh
+pip install quicopt              # core (ir + wire) — standard library only
+pip install "quicopt[pyomo]"     # + the Pyomo front-end
+pip install "quicopt[mathopt]"   # + the OR-Tools MathOpt front-end
+```
+
+From source (contributors), an editable install into a virtual environment:
+
+```sh
+python3 -m venv .venv && . .venv/bin/activate
+pip install -e '.[pyomo,mathopt]'
+```
+
+## Use
+
+```python
+import pyomo.environ as pyo
+from quicopt import Client
+
+m = pyo.ConcreteModel()
+m.x = pyo.Var(bounds=(0.1, 10))
+m.obj = pyo.Objective(expr=m.x**2 + 1.0 / m.x, sense=pyo.minimize)
+
+client = Client("https://quicopt.example")   # your service endpoint
+result = client.solve(m)                      # solve the model — the import to the
+                                              # wire IR happens inside
+print(result.status, result.objective, result.solution)
+print(result.display)                         # the service's ready-to-print summary
+```
+
+`solve` takes the model directly (Pyomo, or an OR-Tools MathOpt model) and imports it
+to the wire IR internally. The first keyless call mints an API key (`client.api_key`);
+reuse it on later calls (`Client(url, api_key=…)`). For a long solve, `client.submit(m)`
+returns a job handle to poll — `job.result()`.
+
+If you need the wire bytes yourself (to inspect or send by another route), the
+front-end importers and encoder are still public:
+
+```python
+from quicopt import encode
+from quicopt.pyomo import import_model
+
+payload = encode(import_model(m))   # Pyomo model → Program → versioned wire bytes
+```
+
+## Layout
+
+```
+quicopt/ir.py      the Program IR data model
+quicopt/wire.py    Program → versioned wire bytes (a stdlib-only encoder)
+quicopt/pyomo.py   Pyomo model → Program (a front-end)
+quicopt/mathopt.py OR-Tools MathOpt model → Program (a front-end)
+quicopt/client.py  POST the wire bytes to the service, read the result (HTTP, stdlib)
+```
+
+The IR and wire format are the client's contract with the service; `wire.py`
+encodes that schema exactly. Each front-end is an independent module beside
+`pyomo.py` (`mathopt.py` for OR-Tools authors; further modeling libraries slot in
+the same way) and pulls in only its own optional extra.
+
+## Test
+
+The encoder is checked against committed golden byte vectors, with **no
+dependencies**:
+
+```sh
+python3 tests/test_wire_golden.py        # or: pytest tests/
+```
+
+## Status
+
+- **ir + wire** — stable; the encoder is byte-exact against what the service decodes.
+- **pyomo importer** — affine / quadratic / nonlinear (`+ - * / ^ sin cos exp log
+  sqrt abs`), variable bounds (incl. unbounded) + integrality, `==` / `<=` / `>=` /
+  ranged constraints, `min` / `max`.
+- **mathopt importer** — OR-Tools MathOpt `ModelProto`: linear / quadratic
+  objective, linear constraints (incl. ranged and one-sided), variable bounds
+  (incl. unbounded) + integrality, `min` / `max`.
+- **transport (HTTP)** — `Client.solve` / `Client.submit` over `/v1/solve` and
+  `/v1/jobs`: wire bytes up, result JSON (status / objective / solution / framed
+  `display`) back; API-key minting on the first call, optional gzip. Standard
+  library only.
+
+## License
+
+Apache License 2.0 — see [`LICENSE`](LICENSE). (c) 2026 Tim Bode, PGI-12, Forschungszentrum Jülich.

quicopt-0.1.0/README.md

@@ -0,0 +1,94 @@
+# quicopt
+
+The Python client for the Quicopt optimization service. Author a model in a Python
+modeling front-end (Pyomo, or OR-Tools MathOpt), convert it to Quicopt's wire IR, and
+emit the versioned, language-neutral bytes the service consumes.
+
+## Install
+
+```sh
+pip install quicopt              # core (ir + wire) — standard library only
+pip install "quicopt[pyomo]"     # + the Pyomo front-end
+pip install "quicopt[mathopt]"   # + the OR-Tools MathOpt front-end
+```
+
+From source (contributors), an editable install into a virtual environment:
+
+```sh
+python3 -m venv .venv && . .venv/bin/activate
+pip install -e '.[pyomo,mathopt]'
+```
+
+## Use
+
+```python
+import pyomo.environ as pyo
+from quicopt import Client
+
+m = pyo.ConcreteModel()
+m.x = pyo.Var(bounds=(0.1, 10))
+m.obj = pyo.Objective(expr=m.x**2 + 1.0 / m.x, sense=pyo.minimize)
+
+client = Client("https://quicopt.example")   # your service endpoint
+result = client.solve(m)                      # solve the model — the import to the
+                                              # wire IR happens inside
+print(result.status, result.objective, result.solution)
+print(result.display)                         # the service's ready-to-print summary
+```
+
+`solve` takes the model directly (Pyomo, or an OR-Tools MathOpt model) and imports it
+to the wire IR internally. The first keyless call mints an API key (`client.api_key`);
+reuse it on later calls (`Client(url, api_key=…)`). For a long solve, `client.submit(m)`
+returns a job handle to poll — `job.result()`.
+
+If you need the wire bytes yourself (to inspect or send by another route), the
+front-end importers and encoder are still public:
+
+```python
+from quicopt import encode
+from quicopt.pyomo import import_model
+
+payload = encode(import_model(m))   # Pyomo model → Program → versioned wire bytes
+```
+
+## Layout
+
+```
+quicopt/ir.py      the Program IR data model
+quicopt/wire.py    Program → versioned wire bytes (a stdlib-only encoder)
+quicopt/pyomo.py   Pyomo model → Program (a front-end)
+quicopt/mathopt.py OR-Tools MathOpt model → Program (a front-end)
+quicopt/client.py  POST the wire bytes to the service, read the result (HTTP, stdlib)
+```
+
+The IR and wire format are the client's contract with the service; `wire.py`
+encodes that schema exactly. Each front-end is an independent module beside
+`pyomo.py` (`mathopt.py` for OR-Tools authors; further modeling libraries slot in
+the same way) and pulls in only its own optional extra.
+
+## Test
+
+The encoder is checked against committed golden byte vectors, with **no
+dependencies**:
+
+```sh
+python3 tests/test_wire_golden.py        # or: pytest tests/
+```
+
+## Status
+
+- **ir + wire** — stable; the encoder is byte-exact against what the service decodes.
+- **pyomo importer** — affine / quadratic / nonlinear (`+ - * / ^ sin cos exp log
+  sqrt abs`), variable bounds (incl. unbounded) + integrality, `==` / `<=` / `>=` /
+  ranged constraints, `min` / `max`.
+- **mathopt importer** — OR-Tools MathOpt `ModelProto`: linear / quadratic
+  objective, linear constraints (incl. ranged and one-sided), variable bounds
+  (incl. unbounded) + integrality, `min` / `max`.
+- **transport (HTTP)** — `Client.solve` / `Client.submit` over `/v1/solve` and
+  `/v1/jobs`: wire bytes up, result JSON (status / objective / solution / framed
+  `display`) back; API-key minting on the first call, optional gzip. Standard
+  library only.
+
+## License
+
+Apache License 2.0 — see [`LICENSE`](LICENSE). (c) 2026 Tim Bode, PGI-12, Forschungszentrum Jülich.

quicopt-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+[build-system]
+requires = ["setuptools>=77"]     # >=77 for the PEP 639 SPDX `license` expression
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "quicopt"
+version = "0.1.0"
+description = "Python client for the Quicopt service — author models, emit the Quicopt wire IR."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [{name = "Tim Bode", email = "9047234+timbode@users.noreply.github.com"}]
+keywords = ["optimization", "mathematical-programming", "modeling", "pyomo", "quicopt"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
+dependencies = []                 # the core (ir + wire) is stdlib-only, by design
+
+[project.optional-dependencies]
+pyomo   = ["pyomo>=6"]            # the Pyomo front-end importer lives in quicopt.pyomo
+mathopt = ["ortools>=9"]          # the OR-Tools MathOpt front-end lives in quicopt.mathopt
+test    = ["pytest"]
+docs    = [                       # the API-reference site (mkdocs build / mkdocs serve)
+    "mkdocs-material>=9",
+    "mkdocstrings[python]>=0.24",
+    "black",                      # mkdocstrings uses it to format rendered signatures
+]
+
+[project.urls]
+Homepage = "https://github.com/timbode/quicopt-python"
+Repository = "https://github.com/timbode/quicopt-python"
+Documentation = "https://timbode.github.io/quicopt-python/"
+
+[tool.setuptools.packages.find]
+where = ["src"]

quicopt-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

quicopt-0.1.0/src/quicopt/__init__.py

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: (c) 2026 Tim Bode, PGI-12, Forschungszentrum Jülich
+"""
+quicopt — the Python client for the Quicopt optimization service.
+
+Authors an optimization model in a Python front-end (Pyomo, …) and converts it to
+Quicopt's wire IR — the versioned, language-neutral contract the service consumes.
+This package is a thin front-end; see ``README.md`` for usage.
+
+Layers:
+  ir      — the ``Program`` IR data model (front-end-agnostic)
+  wire    — ``Program`` → versioned wire bytes (front-end-agnostic)
+  pyomo   — a Pyomo model → ``Program`` importer (a front-end)
+  mathopt — an OR-Tools MathOpt model → ``Program`` importer (a front-end)
+  client  — POST the wire bytes to the service and read the result (HTTP, stdlib)
+"""
+from .ir import (Const, Param, Var, Apply, Reduce, SetRef,
+                 Zero, Nonneg, Indicator,
+                 VarDecl, IndexSet, Constraint, Program,
+                 Domain, CONTINUOUS, INTEGER, BINARY)
+from .wire import encode, encode_params, SCHEMA_VERSION
+from .client import Client, Job, Result, QuicoptError
+
+__all__ = [
+    "Const", "Param", "Var", "Apply", "Reduce", "SetRef",
+    "Zero", "Nonneg", "Indicator",
+    "VarDecl", "IndexSet", "Constraint", "Program",
+    "Domain", "CONTINUOUS", "INTEGER", "BINARY",
+    "encode", "encode_params", "SCHEMA_VERSION",
+    "Client", "Job", "Result", "QuicoptError",
+]