simulatingrisk 1.0.0.post1__tar.gz → 1.1.0.dev0__tar.gz

{simulatingrisk-1.0.0.post1 → simulatingrisk-1.1.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulatingrisk
-Version: 1.0.0.post1
+Version: 1.1.0.dev0
 Summary: Agent-based modeling for simulations related to risk and rationality
 License: Apache-2
 Classifier: Programming Language :: Python :: 3
@@ -9,27 +9,28 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: mesa==2.1.5
 Requires-Dist: matplotlib
-Requires-Dist: altair>5.0.1
+Requires-Dist: altair>=6.1.0
 Provides-Extra: dev
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Provides-Extra: analysis
 Requires-Dist: jupyterlab; extra == "analysis"
-Requires-Dist: polars; extra == "analysis"
+Requires-Dist: polars>1.41.2; extra == "analysis"
 Requires-Dist: hvplot; extra == "analysis"
 Requires-Dist: pyarrow; extra == "analysis"
-Requires-Dist: altair; extra == "analysis"
 Requires-Dist: scipy; extra == "analysis"
 Requires-Dist: scikit-learn; extra == "analysis"
 Requires-Dist: seaborn; extra == "analysis"
-Requires-Dist: vegafusion[embed]>=1.5.0; extra == "analysis"
-Requires-Dist: vl-convert-python; extra == "analysis"
+Requires-Dist: vegafusion[embed]>=2.0.3; extra == "analysis"
+Requires-Dist: vl-convert-python>=1.9.0; extra == "analysis"
 Requires-Dist: great-tables; extra == "analysis"
 Dynamic: license-file
 
 # Simulating Risk
 
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18361156.svg)](https://doi.org/10.5281/zenodo.18361156)
 [![DH community code review: June 2024](https://img.shields.io/badge/DHCodeReview-June_2024-blue)](https://github.com/DHCodeReview/simulating-risk/pull/1) [![unit tests](https://github.com/Princeton-CDH/simulating-risk/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/Princeton-CDH/simulating-risk/actions/workflows/unit_tests.yml)
 
 The code in this repository is associated with the CDH project [Simulating risk, risking simulations](https://cdh.princeton.edu/projects/simulating-risk/).
@@ -38,17 +39,18 @@ Simulations are implemented with [Mesa](https://mesa.readthedocs.io/en/stable/),
 
 ---- 
 
-## Simulations with agent interaction
+## Simulations with risk attitudes and agent interaction
 
 - [Hawk/Dove with risk attitudes](simulatingrisk/hawkdove)
 - [Hawk/Dove with multiple risk attitudes and adjustment](simulatingrisk/hawkdovemulti)
 
-The code for **Hawk/Dove with risk attitudes** and **Hawk/Dove with multiple risk attitudes** in this codebase was [reviewed](https://github.com/DHCodeReview/simulating-risk/pull/1) in June 2024 by [Scott Foster](https://github.com/sgfost) and [Malte Vogl](https://github.com/maltevogl) (Senior Research Fellow, Max Planck Institute of Geoanthropology) via [DHTech Community Code Review](https://dhcodereview.github.io/); review was faciliated by [Cole Crawford](https://github.com/ColeDCrawford) (Senior Software Engineer, Harvard Arts and Humanities Research Computing).
-
+> [!TIP]  
+Run an interactive version of the simulation online: [Hawk/Dove with multiple risk attitudes](https://py.cafe/rlskoeser/simulatingrisk-hawk-dove-multirisk)
 
-View an interactive version of the [Hawk/Dove with multiple risk attitudes](https://py.cafe/rlskoeser/simulatingrisk-hawk-dove-multirisk) simulation online.
+> [!NOTE]
+Altenately, run the simulation in a Jupyter notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Princeton-CDH/simulating-risk.git/HEAD?urlpath=%2Fdoc%2Ftree%2Fsimulatingrisk%2Fhawkdovemulti%2Frun_simulation.ipynb)
 
-The simulation can also be run in a Jupyter notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Princeton-CDH/simulating-risk.git/HEAD?urlpath=%2Fdoc%2Ftree%2Fsimulatingrisk%2Fhawkdovemulti%2Frun_simulation.ipynb)
+The code for **Hawk/Dove with risk attitudes** and **Hawk/Dove with multiple risk attitudes** in this codebase was [reviewed](https://github.com/DHCodeReview/simulating-risk/pull/1) in June 2024 by [Scott Foster](https://github.com/sgfost) and [Malte Vogl](https://github.com/maltevogl) (Senior Research Fellow, Max Planck Institute of Geoanthropology) via [DHTech Community Code Review](https://dhcodereview.github.io/); review was facilitated by [Cole Crawford](https://github.com/ColeDCrawford) (Senior Software Engineer, Harvard Arts and Humanities Research Computing).
 
 ## Simulations with risky choices (environment)
 
@@ -62,19 +64,34 @@ Across simulations, we define agents with risk attitudes tracked via a numeric `
 When the risky bet might be better or worse than the safe bet by the same amount (for example, the risky bet yields 3 or 1 and the safe bet yields 2), an agent who maximizes expected utility will prefer the risky bet when p > 0.5 and will prefer the safe bet when 'p < 0.5'; and they will be indifferent between the risky bet and the safe bet. Thus, r = 0.5 corresponds to expected utility maximization except in the case in which the probability is exactly 0.5 (or, we might say, a point epsilon units to the left of 0.5, where epsilon is smaller than the fineness of our random number generator, corresponds to expected utility maximization). These complications make no difference in practice, so we can simply say that r = 0.5 corresponds to expected utility maximization.
 
 
+```mermaid
+---
+title: risk attitude / risk level (for probabilistic choices)
+---
+flowchart LR
+    r0["<b>0.0</b>
+always takes risky choice
+(any risk is acceptable)"]
+    reu["<b>0.5</b>
+risk neutral
+(expected utility maximizer)"]
+    r1["<b>1.0</b>
+always takes safe choice
+(no risk is acceptable)"]
+    r0 ---|risk seeking|reu---|risk averse|r1
+```
+
+
 ## Development instructions
 
 Initial setup and installation:
 
 - *Recommmended*: create and activate a Python 3.12 virtualenv:
-
 ```sh
 python3 -m venv simrisk
 source simrisk/bin/activate
 ```
-
 - Install the package, dependencies, and development dependencies:
-
 ```sh
 pip install -e .
 pip install -e ".[dev]"
@@ -94,7 +111,7 @@ An interactive version of the [Solara app with tabs for all simulations](https:/
 is available online.
 
 
-### Running the simulations  (non-solara versions)
+### Running the simulations (non-solara versions)
 
 - Simulations can be run interactively with mesa runserver by specifying
   the path to the model, e.g. `mesa runserver simulatingrisk/risky_bet/`
@@ -111,3 +128,11 @@ Install pre-commit hooks (currently [black](https://github.com/psf/black) and [r
 ```sh
 pre-commit install
 ```
+
+### To run on py.cafe
+
+Build the application as a wheel, excluding dependencies:
+
+```sh
+pip wheel . --no-deps
+```

{simulatingrisk-1.0.0.post1 → simulatingrisk-1.1.0.dev0}/README.md

@@ -1,5 +1,7 @@
 # Simulating Risk
 
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.18361156.svg)](https://doi.org/10.5281/zenodo.18361156)
 [![DH community code review: June 2024](https://img.shields.io/badge/DHCodeReview-June_2024-blue)](https://github.com/DHCodeReview/simulating-risk/pull/1) [![unit tests](https://github.com/Princeton-CDH/simulating-risk/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/Princeton-CDH/simulating-risk/actions/workflows/unit_tests.yml)
 
 The code in this repository is associated with the CDH project [Simulating risk, risking simulations](https://cdh.princeton.edu/projects/simulating-risk/).
@@ -8,17 +10,18 @@ Simulations are implemented with [Mesa](https://mesa.readthedocs.io/en/stable/),
 
 ---- 
 
-## Simulations with agent interaction
+## Simulations with risk attitudes and agent interaction
 
 - [Hawk/Dove with risk attitudes](simulatingrisk/hawkdove)
 - [Hawk/Dove with multiple risk attitudes and adjustment](simulatingrisk/hawkdovemulti)
 
-The code for **Hawk/Dove with risk attitudes** and **Hawk/Dove with multiple risk attitudes** in this codebase was [reviewed](https://github.com/DHCodeReview/simulating-risk/pull/1) in June 2024 by [Scott Foster](https://github.com/sgfost) and [Malte Vogl](https://github.com/maltevogl) (Senior Research Fellow, Max Planck Institute of Geoanthropology) via [DHTech Community Code Review](https://dhcodereview.github.io/); review was faciliated by [Cole Crawford](https://github.com/ColeDCrawford) (Senior Software Engineer, Harvard Arts and Humanities Research Computing).
-
+> [!TIP]  
+Run an interactive version of the simulation online: [Hawk/Dove with multiple risk attitudes](https://py.cafe/rlskoeser/simulatingrisk-hawk-dove-multirisk)
 
-View an interactive version of the [Hawk/Dove with multiple risk attitudes](https://py.cafe/rlskoeser/simulatingrisk-hawk-dove-multirisk) simulation online.
+> [!NOTE]
+Altenately, run the simulation in a Jupyter notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Princeton-CDH/simulating-risk.git/HEAD?urlpath=%2Fdoc%2Ftree%2Fsimulatingrisk%2Fhawkdovemulti%2Frun_simulation.ipynb)
 
-The simulation can also be run in a Jupyter notebook: [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Princeton-CDH/simulating-risk.git/HEAD?urlpath=%2Fdoc%2Ftree%2Fsimulatingrisk%2Fhawkdovemulti%2Frun_simulation.ipynb)
+The code for **Hawk/Dove with risk attitudes** and **Hawk/Dove with multiple risk attitudes** in this codebase was [reviewed](https://github.com/DHCodeReview/simulating-risk/pull/1) in June 2024 by [Scott Foster](https://github.com/sgfost) and [Malte Vogl](https://github.com/maltevogl) (Senior Research Fellow, Max Planck Institute of Geoanthropology) via [DHTech Community Code Review](https://dhcodereview.github.io/); review was facilitated by [Cole Crawford](https://github.com/ColeDCrawford) (Senior Software Engineer, Harvard Arts and Humanities Research Computing).
 
 ## Simulations with risky choices (environment)
 
@@ -32,19 +35,34 @@ Across simulations, we define agents with risk attitudes tracked via a numeric `
 When the risky bet might be better or worse than the safe bet by the same amount (for example, the risky bet yields 3 or 1 and the safe bet yields 2), an agent who maximizes expected utility will prefer the risky bet when p > 0.5 and will prefer the safe bet when 'p < 0.5'; and they will be indifferent between the risky bet and the safe bet. Thus, r = 0.5 corresponds to expected utility maximization except in the case in which the probability is exactly 0.5 (or, we might say, a point epsilon units to the left of 0.5, where epsilon is smaller than the fineness of our random number generator, corresponds to expected utility maximization). These complications make no difference in practice, so we can simply say that r = 0.5 corresponds to expected utility maximization.
 
 
+```mermaid
+---
+title: risk attitude / risk level (for probabilistic choices)
+---
+flowchart LR
+    r0["<b>0.0</b>
+always takes risky choice
+(any risk is acceptable)"]
+    reu["<b>0.5</b>
+risk neutral
+(expected utility maximizer)"]
+    r1["<b>1.0</b>
+always takes safe choice
+(no risk is acceptable)"]
+    r0 ---|risk seeking|reu---|risk averse|r1
+```
+
+
 ## Development instructions
 
 Initial setup and installation:
 
 - *Recommmended*: create and activate a Python 3.12 virtualenv:
-
 ```sh
 python3 -m venv simrisk
 source simrisk/bin/activate
 ```
-
 - Install the package, dependencies, and development dependencies:
-
 ```sh
 pip install -e .
 pip install -e ".[dev]"
@@ -64,7 +82,7 @@ An interactive version of the [Solara app with tabs for all simulations](https:/
 is available online.
 
 
-### Running the simulations  (non-solara versions)
+### Running the simulations (non-solara versions)
 
 - Simulations can be run interactively with mesa runserver by specifying
   the path to the model, e.g. `mesa runserver simulatingrisk/risky_bet/`
@@ -81,3 +99,11 @@ Install pre-commit hooks (currently [black](https://github.com/psf/black) and [r
 ```sh
 pre-commit install
 ```
+
+### To run on py.cafe
+
+Build the application as a wheel, excluding dependencies:
+
+```sh
+pip wheel . --no-deps
+```