PyDiffGame 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

PyDiffGame/__init__.py

@@ -34,7 +34,7 @@ from PyDiffGame.discrete import DiscretePyDiffGame
 from PyDiffGame.lqr import ContinuousLQR, DiscreteLQR
 from PyDiffGame.objective import GameObjective, LQRObjective, Objective
 
-__version__ = "2.0.0"
+__version__ = "2.0.1"
 
 __all__ = [
     "PyDiffGame",

{pydiffgame-2.0.0.dist-info → pydiffgame-2.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PyDiffGame
-Version: 2.0.0
+Version: 2.0.1
 Summary: Nash-equilibrium solutions to linear-quadratic differential games, via a reduction of the Game Hamilton-Jacobi-Bellman equations to coupled algebraic and differential Riccati equations for multi-objective dynamical control systems.
 Project-URL: Homepage, https://krichelj.github.io/PyDiffGame/
 Project-URL: Repository, https://github.com/krichelj/PyDiffGame
@@ -58,7 +58,7 @@ Requires-Dist: control>=0.10; extra == 'examples'
 Description-Content-Type: text/markdown
 
 <p align="center">
-    <img alt="PyDiffGame logo" src="images/logo.png" width="420"/>
+    <img alt="PyDiffGame logo" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/logo.png" width="420"/>
 </p>
 
 <p align="center">
@@ -127,22 +127,32 @@ accounting on a common yardstick, and ready-made plotting.
 
 # Installation
 
-Install the latest release from PyPI:
+PyDiffGame is published on [PyPI](https://pypi.org/project/PyDiffGame/) and is
+managed with [**uv**](https://docs.astral.sh/uv/). Add it to your project:
 
 ```bash
-pip install PyDiffGame
+uv add PyDiffGame
 ```
 
 To run the bundled examples (which additionally need
 [`python-control`](https://python-control.readthedocs.io/)):
 
 ```bash
-pip install "PyDiffGame[examples]"
+uv add "PyDiffGame[examples]"
 ```
 
-To work on the package itself, this project is managed with
-[**uv**](https://docs.astral.sh/uv/). Clone it and sync the locked development
-environment:
+<details>
+<summary><b>Prefer pip?</b> It works as a fallback.</summary>
+
+```bash
+pip install PyDiffGame
+pip install "PyDiffGame[examples]"   # with the examples extra
+```
+
+</details>
+
+To work on the package itself, clone it and sync the locked development
+environment with uv:
 
 ```bash
 git clone https://github.com/krichelj/PyDiffGame.git
@@ -151,7 +161,10 @@ uv sync --extra dev          # creates .venv with the exact locked dependencies
 uv run pre-commit install    # enable the formatting / lint / type-check hooks
 ```
 
-Then run anything through `uv run` (`uv run pytest`, `uv run python -m PyDiffGame.examples.MassesWithSpringsComparison`, …).
+Then run anything through `uv run` (`uv run pytest`,
+`uv run python -m PyDiffGame.examples.MassesWithSpringsComparison`, …). Pip users
+can instead `pip install -e ".[dev]"`, though uv is recommended for the exact
+locked environment.
 
 # Quick start
 
@@ -242,7 +255,7 @@ To show the package in action we compare a differential game against an LQR on a
 masses connected by springs — a textbook coupled, oscillatory system:
 
 <p align="center">
-    <img alt="Two masses connected by springs between two walls" src="images/readme/masses_schematic.png" width="760"/>
+    <img alt="Two masses connected by springs between two walls" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_schematic.png" width="760"/>
 </p>
 
 The physical input space is decomposed along the **modal** directions of $M^{-1}K$, so each
@@ -304,11 +317,11 @@ monolithic optimum **to numerical precision**: the two state trajectories coinci
 (they differ by ~10⁻⁷) and the costs are equal:
 
 <p align="center">
-    <img alt="State trajectories: the decomposed game reproduces the monolithic LQR" src="images/readme/masses_game_vs_lqr.png" width="860"/>
+    <img alt="State trajectories: the decomposed game reproduces the monolithic LQR" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_game_vs_lqr.png" width="860"/>
 </p>
 
 <p align="center">
-    <img alt="Cost comparison: the modal game recovers the LQR optimum" src="images/readme/masses_cost.png" width="440"/>
+    <img alt="Cost comparison: the modal game recovers the LQR optimum" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/readme/masses_cost.png" width="440"/>
 </p>
 
 For this modally-decoupled system the decomposition is **lossless** — and it buys
@@ -316,7 +329,7 @@ For this modally-decoupled system the decomposition is **lossless** — and it b
 player, without re-tuning one monolithic cost matrix.
 
 > The figures above are regenerated from the live solver by
-> [`tools/generate_readme_figures.py`](tools/generate_readme_figures.py)
+> [`tools/generate_readme_figures.py`](https://github.com/krichelj/PyDiffGame/blob/master/tools/generate_readme_figures.py)
 > (`uv run python tools/generate_readme_figures.py`), so they always match the current code.
 
 # More examples
@@ -347,7 +360,7 @@ uv run mypy        src/PyDiffGame            # type-check
 ```
 
 Continuous integration runs the formatter check, linter, type checker and full suite on
-Python 3.11–3.14. See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+Python 3.11–3.14. See [CONTRIBUTING.md](https://github.com/krichelj/PyDiffGame/blob/master/CONTRIBUTING.md) for details.
 
 # Citing
 
@@ -363,7 +376,7 @@ If you use this work, please cite our paper:
     doi={10.1109/MED51440.2021.9480269}}
 ```
 
-Further details can be found in the [citation document](CITATIONS.bib).
+Further details can be found in the [citation document](https://github.com/krichelj/PyDiffGame/blob/master/CITATIONS.bib).
 
 # Acknowledgments
 
@@ -375,7 +388,7 @@ and Bar-Ilan Universities, Israel.
 
 <p align="center">
 <a href="https://istrc.net.technion.ac.il/">
-<img src="images/Logo_ISTRC_Green_English.png" height="80" alt="ISTRC"/>
+<img src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/Logo_ISTRC_Green_English.png" height="80" alt="ISTRC"/>
 </a>
 &emsp;
 <a href="https://in.bgu.ac.il/en/Pages/default.aspx">

{pydiffgame-2.0.0.dist-info → pydiffgame-2.0.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-PyDiffGame/__init__.py,sha256=qvv_2OcKgr_pXiHeqPBnoYTH_qsggEmKsF7mJ_2wMrE,1657
+PyDiffGame/__init__.py,sha256=_Tny98-VXeUcdxdt_mFkp6-XvAuZc_oGOG9UrsGoeZM,1657
 PyDiffGame/_typing.py,sha256=HErUHmfzvkWLPWT1YJl_gpFYZctjkPqsnw3TeHuuggs,912
 PyDiffGame/base.py,sha256=hurrmsjCRQ049rHQGDa78JUBkCbLs-ZufDF8eHW5oNk,17287
 PyDiffGame/comparison.py,sha256=lJVhceZE7FqaNUGu8q1mA6GS0dbBwYFF1mHn0hzKuwM,4145
@@ -33,7 +33,7 @@ PyDiffGame/examples/figures/PVTOL/PVTOL1.png,sha256=FBgKQSal5ZNyBsGz4RaVye0HBBQU
 PyDiffGame/examples/figures/PVTOL/PVTOL10.png,sha256=XyoLMz5WKfg3ny2JxVxVd1Mxjz9WQQn7N87-8YDLisY,77894
 PyDiffGame/examples/figures/PVTOL/PVTOL100.png,sha256=wkMdqrn9hSsIdU-Yhiki3X2fQ7dRRkfLyvBCFx5cMWI,75698
 PyDiffGame/examples/figures/PVTOL/PVTOL1000.png,sha256=Hg_hsf9gnc1HqC4JVjATVay7uDlnIqBRkG8lzpcfiZ0,77630
-pydiffgame-2.0.0.dist-info/METADATA,sha256=ZIqiy-9etdpsJTmpB_K3dfzs97q1NuLQmSQzG2iVuwE,19783
-pydiffgame-2.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
-pydiffgame-2.0.0.dist-info/licenses/LICENSE,sha256=IYfdsBdqL9SmCEWsXUBTYh303LOWQQRCOUOfZI7PWz8,1139
-pydiffgame-2.0.0.dist-info/RECORD,,
+pydiffgame-2.0.1.dist-info/METADATA,sha256=C7i9NhG7bbA3b43Mm35JRBXpTaPR5VOo2FvwRSNVSz8,20580
+pydiffgame-2.0.1.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+pydiffgame-2.0.1.dist-info/licenses/LICENSE,sha256=IYfdsBdqL9SmCEWsXUBTYh303LOWQQRCOUOfZI7PWz8,1139
+pydiffgame-2.0.1.dist-info/RECORD,,