optlens 0.0.1__tar.gz

optlens-0.0.1/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.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

optlens-0.0.1/NOTICE

@@ -0,0 +1,12 @@
+optlens
+Copyright 2026 Jessica Dong
+
+This product is licensed under the Apache License, Version 2.0 (LICENSE).
+
+Test models derived from Gurobi modeling-examples
+(https://github.com/Gurobi/modeling-examples), Copyright Gurobi Optimization, LLC, licensed under the Apache
+License, Version 2.0:
+  tests/fixtures/milp_tutorial__0_RAP.mps                 the resource assignment problem of the milp_tutorial
+                                                          example, written as an MPS file
+  tests/fixtures/ex_milp_tutorial__rhs_tighten__0.mps     the same model with one constraint limit tightened so
+                                                          that it is infeasible (changed for this project)

optlens-0.0.1/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.4
+Name: optlens
+Version: 0.0.1
+Summary: Solver-agnostic diagnostics for LP/MILP models: IIS, feasibility relaxation, repair menus, sensitivity, what-if.
+Author: Jessica Dong
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://optlens.dev
+Project-URL: Repository, https://github.com/jjd-lab/optlens
+Project-URL: Issues, https://github.com/jjd-lab/optlens/issues
+Project-URL: Changelog, https://github.com/jjd-lab/optlens/blob/main/CHANGELOG.md
+Keywords: optimization,linear programming,MILP,infeasibility,IIS,debugging,MCP,Claude Code
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: highspy
+Provides-Extra: scip
+Requires-Dist: pyscipopt; extra == "scip"
+Provides-Extra: gurobi
+Requires-Dist: gurobipy; extra == "gurobi"
+Provides-Extra: pulp
+Requires-Dist: pulp; extra == "pulp"
+Provides-Extra: pyomo
+Requires-Dist: pyomo>=6.7; extra == "pyomo"
+Requires-Dist: packaging; extra == "pyomo"
+Provides-Extra: mcp
+Requires-Dist: mcp>=2.2; extra == "mcp"
+Requires-Dist: anyio; extra == "mcp"
+Requires-Dist: jsonschema; extra == "mcp"
+Dynamic: license-file
+
+# optlens
+
+A solver-agnostic debugger and explainer for LP and MILP models. Give it a model that is infeasible, or that solves
+to an answer you don't trust, and it finds the conflicting constraints, the smallest changes that fix them, and what
+each change costs. Every result comes back as text an agent or a person can read: in your own Python, in Claude Code
+through the plugin, or in any MCP client.
+
+optlens works on a model that is already built. It does not write models.
+
+## Install
+
+Python 3.12 or later:
+
+```bash
+pip install "optlens[scip,mcp]"   # core: numpy, scipy, HiGHS
+```
+
+To run the quickstart below or the tests, clone the repository and install it from the clone
+(`git clone https://github.com/jjd-lab/optlens && cd optlens && pip install ".[scip,mcp]"`). On a network that cannot
+reach GitHub (a proxy, a VPN), copy the source over another way (a zip of the repository) and install from that folder:
+`pip install "<folder>[scip,mcp]"`, and for the Claude Code plugin `claude plugin marketplace add <folder>`.
+
+| extra | adds |
+|---|---|
+| `scip` | SCIP (pyscipopt): a second open-source solver, with a native MIP IIS |
+| `gurobi` | gurobipy: Gurobi, bring your own license. Its version must match your Gurobi: a Compute Server or token server rejects a newer client ("No compatible runtime available"), so install that major version, e.g. `pip install "gurobipy==12.*"`. `open_model` shows the installed gurobipy version |
+| `pyomo`, `pulp` | load Pyomo and PuLP models |
+| `mcp` | the MCP server `optlens-mcp` and the Claude Code plugin |
+
+## Quickstart
+
+```python
+import optlens as od
+from optlens.session import Session, Version
+
+if __name__ == "__main__":  # solves run in worker processes, which start by re-importing this script
+    md = od.load("tests/fixtures/ex_milp_tutorial__rhs_tighten__0.mps")  # LP or MPS
+    s = Session({"v0": Version(md, None, "original model")})
+    print(s.get_model_overview())   # size, status (here INFEASIBLE), constraint families
+    print(s.compute_iis())          # the conflicting constraints, grouped by family
+    print(s.fix_menu())             # the smallest change per family that restores feasibility
+    print(s.modify_and_resolve(changes=[{"action": "set_rhs", "name": "resource[Monika]", "upper": 1}]))
+```
+
+Save it as a file and run it from the repository root. Keep the `if __name__ == "__main__":` guard in any script that
+solves: solves run in worker processes, and on Windows (which starts them with `spawn`) each one re-imports the script,
+so without the guard the script re-runs in every solver process. Every `Session` method returns text, and `optlens.session.TOOLS` holds the matching JSON schemas for an
+agent. A session also covers feasibility relaxation, what-if edits as versions, why-not questions, sensitivity and
+marginal values, suspicious data values, and comparisons between versions or models.
+
+A model built in Pyomo, gurobipy or PuLP loads directly, from the object or from the file that builds it. The file
+is run without its `if __name__ == "__main__":` block and stops at its first solve call (`optimize()`, `solve()`),
+whose model is the one read; nothing is solved, so a large gurobipy model loads on Gurobi's size-limited license.
+
+```python
+md = od.from_object(model)                      # a Pyomo ConcreteModel, gurobipy Model or PuLP LpProblem
+md = od.load("my_model.py")                     # the model it solves, else its one model or build_model()
+md = od.load("my_model.py:make_scenario")       # a named model, or a function with no arguments that returns one
+```
+
+LP files written by Gurobi (bracketed names, which HiGHS rejects) load without gurobipy.
+
+Quadratic objectives (QP, MIQP) are supported: a convex QP solves on HiGHS, and a mixed-integer or non-convex one goes
+to SCIP automatically. Every question works as for a linear model except sensitivity ranges (and shadow prices for a
+non-convex objective). Quadratic constraints, indicator and other general constraints, and SOS
+are rejected when the model loads. The full list of questions, formats and solvers: [optlens.dev/ask](https://optlens.dev/ask/).
+
+## Solvers
+
+HiGHS comes with the core; SCIP and Gurobi are extras. Pick one with `OPTLENS_SOLVER` (`highs`, `scip`, `gurobi`, or
+`auto`, the default), `open_model`'s `solver` in the MCP server, or `Session(..., prefer=...)`. Under `auto` without
+Gurobi, each model goes to HiGHS or SCIP (a larger MIP's first solve races both).
+
+- **Every solve has a hard time limit.** Solvers do not always honour their own (SCIP once ran 862 s on a 30 s
+  limit), so each solve runs in a worker process that is stopped at the limit.
+- **Gurobi does every step itself.** A Gurobi session solves, computes IIS, relaxes, ranges and checks on Gurobi; no
+  step is handed to another solver. If you chose Gurobi and it cannot run a model (not installed, or over the
+  size-limited license), the tool stops and says so instead of switching. Under `auto` it uses Gurobi when it can
+  run here (checked once with a one-variable solve: an installed gurobipy with no usable license, or a version your
+  license server rejects, is left out, and `open_model` says why) and falls back to HiGHS or SCIP for a model Gurobi
+  cannot run, and says so.
+- **HiGHS and SCIP stand in for each other** where only one can do a step (HiGHS has no MIP IIS; SCIP does), or
+  when one gives no verdict within its limit (the other tries once), and the result names the solver that did it.
+- **Every IIS is checked.** A solver's IIS whose constraints are feasible on their own is rejected and rebuilt by
+  removing constraints one at a time on the same solver. This guards against a known gurobipy 13.0.3 bug: `computeIIS` leaves out a
+  one-variable row on a binary whose fractional limit rounds it to 0 (`160 open <= 100` with `open >= 1` returns
+  `open >= 1` alone, which is feasible).
+- **Gurobi is tested on small models and on one large one** (a 279k-row hotel model: solves, sensitivity, IIS,
+  relaxations and repair menus). Other large models are untested; reports are welcome.
+
+On large models (hundreds of thousands of constraints) the IIS search starts near the conflict, from HiGHS's infeasibility
+proof, instead of searching the whole model.
+
+## Use it with your agent
+
+Install as above (it puts `optlens-mcp` on your PATH), then connect once; the agent gets the 22 tools and the method
+(open the model first, lead with the cause, every number from a solve, re-solve before recommending a fix) with them.
+
+| agent | connect |
+|---|---|
+| **Claude Code** | `claude plugin marketplace add jjd-lab/optlens` then `claude plugin install optlens@optlens` (or the same as `/plugin` commands in a session) |
+| **Codex CLI** | `codex mcp add optlens -- optlens-mcp` |
+| **Cursor** | in `.cursor/mcp.json` (or `~/.cursor/mcp.json`): `{"mcpServers": {"optlens": {"command": "optlens-mcp"}}}` |
+| **VS Code (Copilot)** | in `.vscode/mcp.json`: `{"servers": {"optlens": {"type": "stdio", "command": "optlens-mcp"}}}` |
+| **Claude Desktop** | in `claude_desktop_config.json` (Settings > Developer > Edit Config): `{"mcpServers": {"optlens": {"command": "optlens-mcp"}}}` |
+| **Any other MCP client** | run `optlens-mcp` as a stdio server |
+
+The command must be on the PATH the agent sees; give the full path to `optlens-mcp` (for example `.venv/bin/optlens-mcp`)
+if it is not. `OPTLENS_SOLVER` (`highs`, `scip`, `gurobi` or `auto`) chooses the solver once.
+
+**Time limits.** Solves stop at 45 s, so a call answers within a minute. `OPTLENS_CALL_LIMIT` (seconds, at least 30)
+is the most one tool call may take: a tool's `time_limit` may ask for up to 15 s less, and the agent asks for more only
+when a solve stopped at its limit while still improving (results say whether it was). Set it to what your client waits
+for one tool call; `open_model` states the limits in force, and a result cut short by one says so.
+
+| client | waits for a tool call | `OPTLENS_CALL_LIMIT` |
+|---|---|---|
+| Claude Code (plugin) | 10 minutes, set by the plugin (calls past 2 minutes move to the background) | 110, set by the plugin |
+| Claude Code (`claude mcp add`) | `MCP_TOOL_TIMEOUT` (about 28 hours unless set; some environments set 60 s) | 60 unless set; to allow more, add `"timeout": 600000` to the server's entry and set 110 |
+| Claude Desktop, MCP TypeScript SDK clients | 60 s | 60 (the default) |
+| other clients | see the client's settings | 60 unless the client allows more |
+
+Large MIPs may not finish within any of these; results then report the plan found, its bound and its gap.
+
+Then ask: *"Why is `plan.mps` infeasible, and what fixes it?"* The agent opens the model, writes its context once
+(what each constraint and variable family means, as JSON in `.optlens/context/` that you can review and commit), and
+works through the tools. For several steps or many solves it uses `run_python`, a persistent Python process with the
+engine preloaded as `session` and the model loaded once.
+
+The Claude Code plugin is the same server plus a skill that carries the same method ([plugin/README.md](https://github.com/jjd-lab/optlens/blob/main/plugin/README.md)).
+
+**Security.** optlens runs code on your machine, with your permissions, and has no sandbox: `run_python` executes
+the code the agent writes (its process starts without your API keys and tokens, but can read and write whatever your
+user can; in Claude Code you approve each call), and opening a `.py` model runs that file up to its first solve call.
+Open only models and code you trust. To report a vulnerability, see [SECURITY.md](https://github.com/jjd-lab/optlens/blob/main/SECURITY.md).
+
+## Try it
+
+To try the plugin without touching your own Claude Code setup, build a clean one in a folder of its own: its own venv
+(optlens from GitHub), its own Claude config with only the optlens plugin, and a hotel week whose data load went wrong
+([packs/hotel/examples/try_week](https://github.com/jjd-lab/optlens/blob/main/packs/hotel/examples/try_week/README.md)),
+with five questions to ask:
+
+```bash
+git clone https://github.com/jjd-lab/optlens && optlens/scripts/sandbox.sh ~/optlens-try
+~/optlens-try/start.sh          # log in on the first start; the questions are in ~/optlens-try/HOW-TO.md
+```
+
+It needs bash, Python 3.12+ and Claude Code (macOS or Linux; on Windows, WSL, or the PowerShell steps in
+[plugin/README.md](https://github.com/jjd-lab/optlens/blob/main/plugin/README.md#windows)). `--project PATH` puts your own model
+there instead. It is a separate setup, not a security sandbox (see Security
+above); delete the folder to remove it.
+
+The same week in a clean Claude Code with the plugin (rendered from a recorded session; each tool call shows its real
+duration):
+
+![Claude Code with the optlens plugin finds why the week's hotel plan is infeasible, checks the fix, and ranks the business rules by the revenue they cost](https://raw.githubusercontent.com/jjd-lab/optlens/main/docs/plugin-agent-demo.svg)
+
+## Hotel pack
+
+[packs/hotel/](https://github.com/jjd-lab/optlens/blob/main/packs/hotel/README.md) is a synthetic hotel revenue-management model (room type × night × length of stay
+× booking window × rate tier) with its generator, its document, domain notes and helpers. It builds models from a
+few thousand to 837,000 constraints, for trying optlens on something realistic and large.
+
+## Tests
+
+```bash
+python -m unittest discover -s tests -t .                             # the engine, from the repo root
+cd packs/hotel && python -m unittest discover -s tests -t .           # the hotel pack
+```
+
+## Contact
+
+Questions, feedback on your own models, or access to **optchat**, the chat agent built on optlens for business users
+(available on request): **hello@optlens.dev**. Bugs and feature requests: GitHub issues.
+
+A planner's session with optchat on the hotel pack's model (a 14-night plan, after a data load typed one night's group
+target as 1,200 instead of 120). Each answer ends with the engine calls, time and cost it took; waiting time is cut
+to two seconds:
+
+![A planner asks why the week's plan is infeasible, approves the fix, and asks which rule costs the most revenue](https://raw.githubusercontent.com/jjd-lab/optlens/main/docs/planner-agent-demo.svg)
+
+## Contributing
+
+Issues with your own models are the most useful contribution; see
+[CONTRIBUTING.md](https://github.com/jjd-lab/optlens/blob/main/CONTRIBUTING.md) and the
+[code of conduct](https://github.com/jjd-lab/optlens/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+Apache-2.0 ([LICENSE](https://github.com/jjd-lab/optlens/blob/main/LICENSE)); third-party credits in [NOTICE](https://github.com/jjd-lab/optlens/blob/main/NOTICE).

optlens-0.0.1/README.md

@@ -0,0 +1,191 @@
+# optlens
+
+A solver-agnostic debugger and explainer for LP and MILP models. Give it a model that is infeasible, or that solves
+to an answer you don't trust, and it finds the conflicting constraints, the smallest changes that fix them, and what
+each change costs. Every result comes back as text an agent or a person can read: in your own Python, in Claude Code
+through the plugin, or in any MCP client.
+
+optlens works on a model that is already built. It does not write models.
+
+## Install
+
+Python 3.12 or later:
+
+```bash
+pip install "optlens[scip,mcp]"   # core: numpy, scipy, HiGHS
+```
+
+To run the quickstart below or the tests, clone the repository and install it from the clone
+(`git clone https://github.com/jjd-lab/optlens && cd optlens && pip install ".[scip,mcp]"`). On a network that cannot
+reach GitHub (a proxy, a VPN), copy the source over another way (a zip of the repository) and install from that folder:
+`pip install "<folder>[scip,mcp]"`, and for the Claude Code plugin `claude plugin marketplace add <folder>`.
+
+| extra | adds |
+|---|---|
+| `scip` | SCIP (pyscipopt): a second open-source solver, with a native MIP IIS |
+| `gurobi` | gurobipy: Gurobi, bring your own license. Its version must match your Gurobi: a Compute Server or token server rejects a newer client ("No compatible runtime available"), so install that major version, e.g. `pip install "gurobipy==12.*"`. `open_model` shows the installed gurobipy version |
+| `pyomo`, `pulp` | load Pyomo and PuLP models |
+| `mcp` | the MCP server `optlens-mcp` and the Claude Code plugin |
+
+## Quickstart
+
+```python
+import optlens as od
+from optlens.session import Session, Version
+
+if __name__ == "__main__":  # solves run in worker processes, which start by re-importing this script
+    md = od.load("tests/fixtures/ex_milp_tutorial__rhs_tighten__0.mps")  # LP or MPS
+    s = Session({"v0": Version(md, None, "original model")})
+    print(s.get_model_overview())   # size, status (here INFEASIBLE), constraint families
+    print(s.compute_iis())          # the conflicting constraints, grouped by family
+    print(s.fix_menu())             # the smallest change per family that restores feasibility
+    print(s.modify_and_resolve(changes=[{"action": "set_rhs", "name": "resource[Monika]", "upper": 1}]))
+```
+
+Save it as a file and run it from the repository root. Keep the `if __name__ == "__main__":` guard in any script that
+solves: solves run in worker processes, and on Windows (which starts them with `spawn`) each one re-imports the script,
+so without the guard the script re-runs in every solver process. Every `Session` method returns text, and `optlens.session.TOOLS` holds the matching JSON schemas for an
+agent. A session also covers feasibility relaxation, what-if edits as versions, why-not questions, sensitivity and
+marginal values, suspicious data values, and comparisons between versions or models.
+
+A model built in Pyomo, gurobipy or PuLP loads directly, from the object or from the file that builds it. The file
+is run without its `if __name__ == "__main__":` block and stops at its first solve call (`optimize()`, `solve()`),
+whose model is the one read; nothing is solved, so a large gurobipy model loads on Gurobi's size-limited license.
+
+```python
+md = od.from_object(model)                      # a Pyomo ConcreteModel, gurobipy Model or PuLP LpProblem
+md = od.load("my_model.py")                     # the model it solves, else its one model or build_model()
+md = od.load("my_model.py:make_scenario")       # a named model, or a function with no arguments that returns one
+```
+
+LP files written by Gurobi (bracketed names, which HiGHS rejects) load without gurobipy.
+
+Quadratic objectives (QP, MIQP) are supported: a convex QP solves on HiGHS, and a mixed-integer or non-convex one goes
+to SCIP automatically. Every question works as for a linear model except sensitivity ranges (and shadow prices for a
+non-convex objective). Quadratic constraints, indicator and other general constraints, and SOS
+are rejected when the model loads. The full list of questions, formats and solvers: [optlens.dev/ask](https://optlens.dev/ask/).
+
+## Solvers
+
+HiGHS comes with the core; SCIP and Gurobi are extras. Pick one with `OPTLENS_SOLVER` (`highs`, `scip`, `gurobi`, or
+`auto`, the default), `open_model`'s `solver` in the MCP server, or `Session(..., prefer=...)`. Under `auto` without
+Gurobi, each model goes to HiGHS or SCIP (a larger MIP's first solve races both).
+
+- **Every solve has a hard time limit.** Solvers do not always honour their own (SCIP once ran 862 s on a 30 s
+  limit), so each solve runs in a worker process that is stopped at the limit.
+- **Gurobi does every step itself.** A Gurobi session solves, computes IIS, relaxes, ranges and checks on Gurobi; no
+  step is handed to another solver. If you chose Gurobi and it cannot run a model (not installed, or over the
+  size-limited license), the tool stops and says so instead of switching. Under `auto` it uses Gurobi when it can
+  run here (checked once with a one-variable solve: an installed gurobipy with no usable license, or a version your
+  license server rejects, is left out, and `open_model` says why) and falls back to HiGHS or SCIP for a model Gurobi
+  cannot run, and says so.
+- **HiGHS and SCIP stand in for each other** where only one can do a step (HiGHS has no MIP IIS; SCIP does), or
+  when one gives no verdict within its limit (the other tries once), and the result names the solver that did it.
+- **Every IIS is checked.** A solver's IIS whose constraints are feasible on their own is rejected and rebuilt by
+  removing constraints one at a time on the same solver. This guards against a known gurobipy 13.0.3 bug: `computeIIS` leaves out a
+  one-variable row on a binary whose fractional limit rounds it to 0 (`160 open <= 100` with `open >= 1` returns
+  `open >= 1` alone, which is feasible).
+- **Gurobi is tested on small models and on one large one** (a 279k-row hotel model: solves, sensitivity, IIS,
+  relaxations and repair menus). Other large models are untested; reports are welcome.
+
+On large models (hundreds of thousands of constraints) the IIS search starts near the conflict, from HiGHS's infeasibility
+proof, instead of searching the whole model.
+
+## Use it with your agent
+
+Install as above (it puts `optlens-mcp` on your PATH), then connect once; the agent gets the 22 tools and the method
+(open the model first, lead with the cause, every number from a solve, re-solve before recommending a fix) with them.
+
+| agent | connect |
+|---|---|
+| **Claude Code** | `claude plugin marketplace add jjd-lab/optlens` then `claude plugin install optlens@optlens` (or the same as `/plugin` commands in a session) |
+| **Codex CLI** | `codex mcp add optlens -- optlens-mcp` |
+| **Cursor** | in `.cursor/mcp.json` (or `~/.cursor/mcp.json`): `{"mcpServers": {"optlens": {"command": "optlens-mcp"}}}` |
+| **VS Code (Copilot)** | in `.vscode/mcp.json`: `{"servers": {"optlens": {"type": "stdio", "command": "optlens-mcp"}}}` |
+| **Claude Desktop** | in `claude_desktop_config.json` (Settings > Developer > Edit Config): `{"mcpServers": {"optlens": {"command": "optlens-mcp"}}}` |
+| **Any other MCP client** | run `optlens-mcp` as a stdio server |
+
+The command must be on the PATH the agent sees; give the full path to `optlens-mcp` (for example `.venv/bin/optlens-mcp`)
+if it is not. `OPTLENS_SOLVER` (`highs`, `scip`, `gurobi` or `auto`) chooses the solver once.
+
+**Time limits.** Solves stop at 45 s, so a call answers within a minute. `OPTLENS_CALL_LIMIT` (seconds, at least 30)
+is the most one tool call may take: a tool's `time_limit` may ask for up to 15 s less, and the agent asks for more only
+when a solve stopped at its limit while still improving (results say whether it was). Set it to what your client waits
+for one tool call; `open_model` states the limits in force, and a result cut short by one says so.
+
+| client | waits for a tool call | `OPTLENS_CALL_LIMIT` |
+|---|---|---|
+| Claude Code (plugin) | 10 minutes, set by the plugin (calls past 2 minutes move to the background) | 110, set by the plugin |
+| Claude Code (`claude mcp add`) | `MCP_TOOL_TIMEOUT` (about 28 hours unless set; some environments set 60 s) | 60 unless set; to allow more, add `"timeout": 600000` to the server's entry and set 110 |
+| Claude Desktop, MCP TypeScript SDK clients | 60 s | 60 (the default) |
+| other clients | see the client's settings | 60 unless the client allows more |
+
+Large MIPs may not finish within any of these; results then report the plan found, its bound and its gap.
+
+Then ask: *"Why is `plan.mps` infeasible, and what fixes it?"* The agent opens the model, writes its context once
+(what each constraint and variable family means, as JSON in `.optlens/context/` that you can review and commit), and
+works through the tools. For several steps or many solves it uses `run_python`, a persistent Python process with the
+engine preloaded as `session` and the model loaded once.
+
+The Claude Code plugin is the same server plus a skill that carries the same method ([plugin/README.md](https://github.com/jjd-lab/optlens/blob/main/plugin/README.md)).
+
+**Security.** optlens runs code on your machine, with your permissions, and has no sandbox: `run_python` executes
+the code the agent writes (its process starts without your API keys and tokens, but can read and write whatever your
+user can; in Claude Code you approve each call), and opening a `.py` model runs that file up to its first solve call.
+Open only models and code you trust. To report a vulnerability, see [SECURITY.md](https://github.com/jjd-lab/optlens/blob/main/SECURITY.md).
+
+## Try it
+
+To try the plugin without touching your own Claude Code setup, build a clean one in a folder of its own: its own venv
+(optlens from GitHub), its own Claude config with only the optlens plugin, and a hotel week whose data load went wrong
+([packs/hotel/examples/try_week](https://github.com/jjd-lab/optlens/blob/main/packs/hotel/examples/try_week/README.md)),
+with five questions to ask:
+
+```bash
+git clone https://github.com/jjd-lab/optlens && optlens/scripts/sandbox.sh ~/optlens-try
+~/optlens-try/start.sh          # log in on the first start; the questions are in ~/optlens-try/HOW-TO.md
+```
+
+It needs bash, Python 3.12+ and Claude Code (macOS or Linux; on Windows, WSL, or the PowerShell steps in
+[plugin/README.md](https://github.com/jjd-lab/optlens/blob/main/plugin/README.md#windows)). `--project PATH` puts your own model
+there instead. It is a separate setup, not a security sandbox (see Security
+above); delete the folder to remove it.
+
+The same week in a clean Claude Code with the plugin (rendered from a recorded session; each tool call shows its real
+duration):
+
+![Claude Code with the optlens plugin finds why the week's hotel plan is infeasible, checks the fix, and ranks the business rules by the revenue they cost](https://raw.githubusercontent.com/jjd-lab/optlens/main/docs/plugin-agent-demo.svg)
+
+## Hotel pack
+
+[packs/hotel/](https://github.com/jjd-lab/optlens/blob/main/packs/hotel/README.md) is a synthetic hotel revenue-management model (room type × night × length of stay
+× booking window × rate tier) with its generator, its document, domain notes and helpers. It builds models from a
+few thousand to 837,000 constraints, for trying optlens on something realistic and large.
+
+## Tests
+
+```bash
+python -m unittest discover -s tests -t .                             # the engine, from the repo root
+cd packs/hotel && python -m unittest discover -s tests -t .           # the hotel pack
+```
+
+## Contact
+
+Questions, feedback on your own models, or access to **optchat**, the chat agent built on optlens for business users
+(available on request): **hello@optlens.dev**. Bugs and feature requests: GitHub issues.
+
+A planner's session with optchat on the hotel pack's model (a 14-night plan, after a data load typed one night's group
+target as 1,200 instead of 120). Each answer ends with the engine calls, time and cost it took; waiting time is cut
+to two seconds:
+
+![A planner asks why the week's plan is infeasible, approves the fix, and asks which rule costs the most revenue](https://raw.githubusercontent.com/jjd-lab/optlens/main/docs/planner-agent-demo.svg)
+
+## Contributing
+
+Issues with your own models are the most useful contribution; see
+[CONTRIBUTING.md](https://github.com/jjd-lab/optlens/blob/main/CONTRIBUTING.md) and the
+[code of conduct](https://github.com/jjd-lab/optlens/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+Apache-2.0 ([LICENSE](https://github.com/jjd-lab/optlens/blob/main/LICENSE)); third-party credits in [NOTICE](https://github.com/jjd-lab/optlens/blob/main/NOTICE).