PyDiffGame 0.1.0__tar.gz → 0.1.2__tar.gz

pydiffgame-0.1.2/.github/workflows/python-publish.yml

@@ -0,0 +1,70 @@
+# This workflow will upload a Python Package to PyPI when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      url: https://pypi.org/project/PyDiffGame/
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      # url: https://pypi.org/project/YOURPROJECT/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

pydiffgame-0.1.2/CITATIONS.bib

@@ -0,0 +1,23 @@
+@software{pydiffgame_package,
+  author = {Kricheli, Joshua Shay and Sadon, Aviran},
+  title = {{PyDiffGame}},
+  howpublished = {\url{https://krichelj.github.io/PyDiffGame/}},
+  year = {2021},
+}
+
+@inproceedings{pydiffgame_paper,
+    author={Kricheli, Joshua Shay and Sadon, Aviran and Arogeti, Shai and Regev, Shimon and Weiss, Gera},
+    booktitle={29th Mediterranean Conference on Control and Automation (MED 2021)},
+    title={{Composition of Dynamic Control Objectives Based on Differential Games}},
+    year={2021},
+    volume={},
+    number={},
+    pages={298-304},
+    doi={10.1109/MED51440.2021.9480269}}
+
+@mastersthesis{kricheli2022differential,
+  title={{Differential Games for Compositional Handling of Competing Control Tasks}},
+  author={Kricheli, Joshua Shay},
+  year={2022},
+  school={Ben-Gurion University of the Negev}
+}

pydiffgame-0.1.2/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

pydiffgame-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contribution Guidelines
+
+This repo is part of a research conducted at Ben Gurion University,
+and is thus open source. We would love to receive your input!
+
+Please ensure your pull request adheres to the following guidelines:
+
+- Search previous suggestions before making a new one, as yours may be a duplicate.
+- Make sure your link is useful before submitting.
+- Make an individual pull request for each suggestion.
+- New categories or improvements to the existing categorization are welcome.
+- Check your spelling and grammar.
+- Make sure your text editor is set to remove trailing whitespace.
+- The pull request and commit should have a useful title.
+
+Thank you for your suggestions!
+
+Joshua Shay Kricheli

{PyDiffGame-0.1.0 → pydiffgame-0.1.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 Joshua Shay Kricheli, Dr. Aviran Sadon, Dr. Shai Arogeti and Prof. Gera Weiss
+Copyright (c) 2021-2024 Joshua Shay Kricheli, Dr. Aviran Sadon, Dr. Shai Arogeti and Prof. Gera Weiss
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{PyDiffGame-0.1.0/src/PyDiffGame.egg-info → pydiffgame-0.1.2}/PKG-INFO

@@ -1,27 +1,29 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyDiffGame
-Version: 0.1.0
+Version: 0.1.2
 Summary: PyDiffGame is a Python implementation of a Nash Equilibrium solution to Differential Games, based on a reduction of Game Hamilton-Bellman-Jacobi (GHJB) equations to Game Algebraic and Differential Riccati equations, associated with Multi-Objective Dynamical Control Systems
-Home-page: https://shaykricheli.com/PyDiffGame/
-Author: Dr. Aviran Sadon, Joshua Shay Kricheli and Prof. Gera Weiss
-Author-email: Joshua Shay Kricheli <skricheli2@gmail.com>
-Project-URL: Homepage, https://shaykricheli.com/PyDiffGame/
+Project-URL: Homepage, https://krichelj.github.io/PyDiffGame/
 Project-URL: Bug Tracker, https://github.com/krichelj/PyDiffGame/issues
-Classifier: Programming Language :: Python :: 3
+Author-email: Joshua Shay Kricheli <skricheli2@gmail.com>
+License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-License-File: LICENSE
 
 <p align="center">
     <img alt="Logo" src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/images/logo.png"/>
 </p>
 
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Upload Python Package](https://github.com/krichelj/PyDiffGame/actions/workflows/python-publish.yml/badge.svg)](https://github.com/krichelj/PyDiffGame/actions/workflows/python-publish.yml) [![pages-build-deployment](https://github.com/krichelj/PyDiffGame/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/krichelj/PyDiffGame/actions/workflows/pages/pages-build-deployment)
+
+
   * [What is this?](#what-is-this)
-  * [Local Installation](#local-installation)
+  * [Installation](#installation)
   * [Input Parameters](#input-parameters)
   * [Tutorial](#tutorial)
+  * [Authors](#authors)
   * [Acknowledgments](#acknowledgments)
 
 # What is this?
@@ -36,22 +38,13 @@ The method relies on the formulation given in:
 ([IEEE](https://ieeexplore.ieee.org/document/9480269) | 
 [Research Gate](https://www.researchgate.net/publication/353452024_Composition_of_Dynamic_Control_Objectives_Based_on_Differential_Games))
 
-If you use this work, please cite our paper:
-```
-@conference{med_paper,  
-  author={Kricheli, Joshua Shay and Sadon, Aviran and Arogeti, Shai and Regev, Shimon and Weiss, Gera},
-  booktitle={29th Mediterranean Conference on Control and Automation (MED)}, 
-  title={{Composition of Dynamic Control Objectives Based on Differential Games}}, 
-  year={2021},
-  pages={298-304},
-  doi={10.1109/MED51440.2021.9480269}}
-```
+The package was tested for Python >= 3.10.
 
-# Local Installation
+# Installation
 
-To clone Git repository locally run this from the command prompt:
+To install this package run this from the command prompt:
 ```
-git clone https://github.com/krichelj/PyDiffGame.git
+pip install PyDiffGame
 ```
 
 The package was tested for Python >= 3.10, along with the listed packages versions in [`requirments.txt`](https://github.com/krichelj/PyDiffGame/blob/master/requirements.txt)
@@ -61,34 +54,34 @@ The package was tested for Python >= 3.10, along with the listed packages versio
 The package defines an abstract class [`PyDiffGame.py`](https://github.com/krichelj/PyDiffGame/blob/master/src/PyDiffGame/PyDiffGame.py). An object of this class represents an instance of differential game.
 The input parameters to instantiate a `PyDiffGame` object are:
 
-* `A` : `np.array` of shape( $n,n$ )
+* `A` : `np.array` of shape $(n,n)$
 >System dynamics matrix
-* `B` : `np.array` of shape( $n,\sum_{i=}1^N m_i$ ), optional
+* `B` : `np.array` of shape $(n, m_1 + ... + m_N)$, optional
 >Input matrix for all virtual control objectives
-* `Bs` : `Sequence` of `np.array` objects of len( $N$ ), each array $B_i$ of shape( $n,m_i$ ), optional
+* `Bs` : `Sequence` of `np.array` objects of len $(N)$, each array $B_i$ of shape $(n,m_i)$, optional
 >Input matrices for each virtual control objective
-* `Qs` : `Sequence` of `np.array` objects of len( $N$ ), each array $Q_i$ of shape( $n,n$ ), optional
+* `Qs` : `Sequence` of `np.array` objects of len $(N)$, each array $Q_i$ of shape $(n,n)$, optional
 >State weight matrices for each virtual control objective
-* `Rs` : `Sequence` of `np.array` objects of len( $N$ ), each array $R_i$ of shape( $m_i,m_i$ ), optional
+* `Rs` : `Sequence` of `np.array` objects of len $(N)$, each array $R_i$ of shape $(m_i,m_i)$, optional
 >Input weight matrices for each virtual control objective
-* `Ms` : `Sequence` of `np.array` objects of len( $N$ ), each array $M_i$ of shape( $m_i,m$ ), optional
+* `Ms` : `Sequence` of `np.array` objects of len $(N)$, each array $M_i$ of shape $(m_i,m)$, optional
 >Decomposition matrices for each virtual control objective
-* `objectives` : `Sequence` of `Objective` objects of len( $N$ ), each $O_i$ specifying $Q_i, R_i$ and $M_i$, optional
+* `objectives` : `Sequence` of `Objective` objects of len $(N)$, each $O_i$ specifying $Q_i, R_i$ and $M_i$, optional
 >Desired objectives for the game
-* `x_0` : `np.array` of len( $n$ ), optional
+* `x_0` : `np.array` of len $(n)$, optional
 >Initial state vector
-* `x_T` : `np.array` of len( $n$ ), optional
+* `x_T` : `np.array` of len $(n)$, optional
 >Final state vector, in case of signal tracking
 * `T_f` : positive `float`, optional
 >System dynamics horizon. Should be given in the case of finite horizon
-* `P_f` : `list` of `np.array` objects of len( $N$ ), each array $P_{f_i}$ of shape( $n,n$ ), optional, default = uncoupled solution of `scipy's solve_are`
+* `P_f` : `list` of `np.array` objects of len $(N)$, each array $P_{f_i}$ of shape $(n,n)$, optional, default = uncoupled solution of `scipy's solve_are`
 >
 >Final condition for the Riccati equation array. Should be given in the case of finite horizon
-* `state_variables_names` : `Sequence` of `str` objects of len( $N$ ), optional
+* `state_variables_names` : `Sequence` of `str` objects of len $(N)$, optional
 >The state variables' names to display when plotting
 * `show_legend` : `boolean`, optional
 >Indicates whether to display a legend in the plots
-* `state_variables_names` : `Sequence` of `str` objects of len( $n$ ), optional
+* `state_variables_names` : `Sequence` of `str` objects of len $(n)$, optional
 >The state variables' names to display
 * `epsilon_x` : `float` in the interval $(0,1)$, optional
 >Numerical convergence threshold for the state vector of the system
@@ -109,7 +102,7 @@ Consider the following system of masses and springs:
 
 
 <p align="center">
-    <img align=top src="src/PyDiffGame/examples/figures/2/two_masses_tikz.png" width="797" height="130"/>
+    <img align=top src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/src/PyDiffGame/examples/figures/2/two_masses_tikz.png" width="797" height="130"/>
 </p>
 
 The performance of the system under the use of the suggested method is compared with that of a Linear Quadratic Regulator (LQR). For that purpose, class named [`PyDiffGameLQRComparison`](https://github.com/krichelj/PyDiffGame/blob/master/src/PyDiffGame/PyDiffGameLQRComparison.py) is defined. A comparison of a system should subclass this class.
@@ -246,12 +239,11 @@ masses_with_springs(plot_state_spaces=True,
                     save_figure=True)
 ```
 
-Refer 
 This will result in the following plot that compares the two systems performance for a differential game vs an LQR:
 
 <p align="center">
-    <img align=top src="src/PyDiffGame/examples/figures/2/2-players_large_1.png" width="400" height="300"/>
-    <img align=top src="src/PyDiffGame/examples/figures/2/LQR_large_1.png" width="400" height="300"/>
+    <img align=top src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/src/PyDiffGame/examples/figures/2/2-players_large_1.png" width="400" height="300"/>
+    <img align=top src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/src/PyDiffGame/examples/figures/2/LQR_large_1.png" width="400" height="300"/>
 </p>
 
 
@@ -264,32 +256,51 @@ qs = [[500, 5000]]
 we have: 
 
 <p align="center">
-    <img align=top src="src/PyDiffGame/examples/figures/2/2-players_large_2.png" width="400" height="300"/>
-    <img align=top src="src/PyDiffGame/examples/figures/2/LQR_large_2.png" width="400" height="300"/>
+    <img align=top src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/src/PyDiffGame/examples/figures/2/2-players_large_2.png" width="400" height="300"/>
+    <img align=top src="https://raw.githubusercontent.com/krichelj/PyDiffGame/master/src/PyDiffGame/examples/figures/2/LQR_large_2.png" width="400" height="300"/>
 </p>
 
+# Authors
+
+If you use this work, please cite our paper:
+```
+@inproceedings{pydiffgame_paper,
+    author={Kricheli, Joshua Shay and Sadon, Aviran and Arogeti, Shai and Regev, Shimon and Weiss, Gera},
+    booktitle={29th Mediterranean Conference on Control and Automation (MED 2021)},
+    title={{Composition of Dynamic Control Objectives Based on Differential Games}},
+    year={2021},
+    volume={},
+    number={},
+    pages={298-304},
+    doi={10.1109/MED51440.2021.9480269}}
+```
+
+Further details can be found in the [citation document](CITATIONS.bib).
 
 # Acknowledgments
 
-This research was supported in part by the Helmsley Charitable Trust through the Agricultural, Biological and Cognitive Robotics Initiative and by the Marcus Endowment Fund both at Ben-Gurion University of the Negev, Israel.
-This research was also supported by The Israeli Smart Transportation Research Center (ISTRC) by The Technion and Bar-Ilan Universities, Israel.
+This research was supported in part by the Leona M. and Harry B. Helmsley Charitable Trust through the '_Agricultural, Biological and Cognitive Robotics Initiative_' ('ABC') and by the Marcus Endowment Fund both at Ben-Gurion University of the Negev, Israel.
+This research was also supported by The '_Israeli Smart Transportation Research Center_' ('ISTRC') by The Technion and Bar-Ilan Universities, Israel.
 
 <p align="center">
-    <a href="https://istrc.net.technion.ac.il/">
-    <img src="images/Logo_ISTRC_Green_English.png" width="180"  alt=""/>
-    </a>
-&emsp;
-&emsp;
-&emsp;
+<a href="https://istrc.net.technion.ac.il/">
+<img src="https://github.com/krichelj/PyDiffGame/blob/master/images/Logo_ISTRC_Green_English.png?raw=true" width="233"  alt=""/>
+</a>
 &emsp;
 <a href="https://in.bgu.ac.il/en/Pages/default.aspx">
-<img src="images/BGU-logo-round.png" width="150"  alt=""/>
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcTZ8GbtJiX8lNUygX7-inRBuWESK438jWbRjQ&s">
+  <source media="(prefers-color-scheme: light)" srcset="https://tamrur.bgu.ac.il/restore/BGU.sig.png">
+  <img alt="BGU Logo" src="https://tamrur.bgu.ac.il/restore/BGU.sig.png" width="233" class="bgu-logo-dark">
+</picture>
 </a>
 &emsp;
 &emsp;
-&emsp;
-&emsp;
-<a href="https://in.bgu.ac.il/en/robotics/Pages/default.aspx">
-<img src="images/logo_abc.png" width="180"  alt=""/>
+<a href="https://helmsleytrust.org/">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://helmsleytrust.org/wp-content/themes/helmsley/assets/img/helmsley-charitable-trust-logo-white.png">
+  <source media="(prefers-color-scheme: light)" srcset="https://helmsleytrust.org/wp-content/themes/helmsley/assets/img/helmsley-charitable-trust-logo-blue.png">
+  <img alt="Helmsley Charitable Trust" src="https://helmsleytrust.org/wp-content/themes/helmsley/assets/img/helmsley-charitable-trust-logo-blue.png" width="233">
+</picture>
 </a>
 </p>