SearchLibrium 0.0.140__tar.gz → 0.0.142__tar.gz

searchlibrium-0.0.142/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include src/SearchLibrium/version.txt
+recursive-include src/SearchLibrium/data *.csv

{searchlibrium-0.0.140 → searchlibrium-0.0.142}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: SearchLibrium
-Version: 0.0.140
+Version: 0.0.142
 Summary: A Python package for econometric models driven by search
 Author: Mario Fernando Taco Morales, Alexander Paz, Prithvi Beeramole, Robert Burdett
 Author-email: Zeke Ahern <z.ahern@qut.edu.au>
@@ -27,6 +27,9 @@ Requires-Dist: statsmodels
 Requires-Dist: jax>=0.4.30
 Requires-Dist: jaxlib>=0.4.30
 Requires-Dist: jaxopt>=0.8.5
+Requires-Dist: addicty
+Requires-Dist: pyfiglet
+Requires-Dist: colorama
 Provides-Extra: jax
 Requires-Dist: jax>=0.4.30; extra == "jax"
 Requires-Dist: jaxlib>=0.4.30; extra == "jax"
@@ -451,16 +454,29 @@ After every `call_siman` run a dashboard is printed:
 
 ## Bundled datasets
 
+Three example choice datasets ship inside the package (`SearchLibrium/data/*.csv`) — no
+download required, and they work offline (e.g. on HPC compute nodes with no internet egress):
+
 ```python
-import SearchLibrium as sl
-sl.main.preview_dataset()   # prints head of each dataset
+from SearchLibrium import (
+    load_electricity_data, load_travel_mode_data, load_swiss_metro_data, preview_datasets,
+)
+
+preview_datasets()   # prints shape + head of all three
+
+df = load_swiss_metro_data()   # the dataset used in Quick Start above
 ```
 
-| Name | Description |
-| ---- | ----------- |
-| `electricity` | Stated-preference electricity plan choice |
-| `travel_mode` | Mode choice: air / train / bus / car |
-| `swiss_metro` | Swiss Metro SP study (SM / train / car) |
+| Name | Loader | Description | Alts | Rows |
+| ---- | ------ | ----------- | ---- | ---- |
+| `electricity` | `load_electricity_data()` | Stated-preference electricity plan choice | 4 | 17,232 |
+| `travel_mode` | `load_travel_mode_data()` | Mode choice: air / train / bus / car | 4 | 840 |
+| `swiss_metro` | `load_swiss_metro_data()` | Swiss Metro SP study (SM / train / car) | 3 | 24,948 |
+
+Each loader's docstring documents the exact `Parameters(...)` call for that dataset — the
+three use different column-naming conventions (e.g. `travel_mode`'s choice column is a
+`"yes"/"no"` string keyed by `mode`, not a `0/1` int keyed by `alt`), so see
+`help(load_travel_mode_data)` rather than assuming a single shared schema.
 
 ---
 

{searchlibrium-0.0.140 → searchlibrium-0.0.142}/README.md

@@ -411,16 +411,29 @@ After every `call_siman` run a dashboard is printed:
 
 ## Bundled datasets
 
+Three example choice datasets ship inside the package (`SearchLibrium/data/*.csv`) — no
+download required, and they work offline (e.g. on HPC compute nodes with no internet egress):
+
 ```python
-import SearchLibrium as sl
-sl.main.preview_dataset()   # prints head of each dataset
+from SearchLibrium import (
+    load_electricity_data, load_travel_mode_data, load_swiss_metro_data, preview_datasets,
+)
+
+preview_datasets()   # prints shape + head of all three
+
+df = load_swiss_metro_data()   # the dataset used in Quick Start above
 ```
 
-| Name | Description |
-| ---- | ----------- |
-| `electricity` | Stated-preference electricity plan choice |
-| `travel_mode` | Mode choice: air / train / bus / car |
-| `swiss_metro` | Swiss Metro SP study (SM / train / car) |
+| Name | Loader | Description | Alts | Rows |
+| ---- | ------ | ----------- | ---- | ---- |
+| `electricity` | `load_electricity_data()` | Stated-preference electricity plan choice | 4 | 17,232 |
+| `travel_mode` | `load_travel_mode_data()` | Mode choice: air / train / bus / car | 4 | 840 |
+| `swiss_metro` | `load_swiss_metro_data()` | Swiss Metro SP study (SM / train / car) | 3 | 24,948 |
+
+Each loader's docstring documents the exact `Parameters(...)` call for that dataset — the
+three use different column-naming conventions (e.g. `travel_mode`'s choice column is a
+`"yes"/"no"` string keyed by `mode`, not a `0/1` int keyed by `alt`), so see
+`help(load_travel_mode_data)` rather than assuming a single shared schema.
 
 ---
 

{searchlibrium-0.0.140 → searchlibrium-0.0.142}/pyproject.toml

@@ -8,6 +8,12 @@ version = {file = "src/SearchLibrium/version.txt"}
 [tool.setuptools.packages]
 find = { where = ["src"] }
 
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+SearchLibrium = ["data/*.csv"]
+
 [project]
 name = "SearchLibrium"
 dynamic = ["version"]
@@ -47,6 +53,9 @@ dependencies = [
     "jax>=0.4.30",
     "jaxlib>=0.4.30",
     "jaxopt>=0.8.5",
+    "addicty",
+    "pyfiglet",
+    "colorama",
 ]
 
 [project.optional-dependencies]
@@ -73,7 +82,7 @@ Documentation = "https://pypi.org/project/SearchLibrium/"
 realpython = "SearchLibrium.__main__:main"
 
 [tool.bumpver]
-current_version = "0.0.140"
+current_version = "0.0.142"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message = "[skip ci] Bump version {old_version} -> {new_version}"
 commit = true

{searchlibrium-0.0.140 → searchlibrium-0.0.142}/src/SearchLibrium/__init__.py

@@ -115,6 +115,7 @@ try:
     from .hspbil import HSPBIL
     from .call_meta import call_harmony, call_harmony_pbil, call_siman, call_parsa, call_search, call_sapbil, call_banditsa, call_parcopsa, estimate_ctrl
     from .predict import DestinationPredictor, predict_destination_components, predict_aggregate_destination_flows
+    from .sample_data import load_electricity_data, load_travel_mode_data, load_swiss_metro_data, preview_datasets
 
 except ImportError as e:
     from _choice_model import DiscreteChoiceModel
@@ -137,6 +138,7 @@ except ImportError as e:
     from hspbil import HSPBIL
     from call_meta import call_siman, call_harmony, call_harmony_pbil, call_search, call_sapbil, call_banditsa, call_parsa, call_parcopsa, estimate_ctrl
     from predict import DestinationPredictor, predict_destination_components, predict_aggregate_destination_flows
+    from sample_data import load_electricity_data, load_travel_mode_data, load_swiss_metro_data, preview_datasets
 try:
     from .main import print_ascii_art_logo
 except Exception:

{searchlibrium-0.0.140 → searchlibrium-0.0.142}/src/SearchLibrium/constraints_builder.py

@@ -422,7 +422,15 @@ class ConstraintBuilder:
                 for k, v in value.items():
                     summary_lines.append(f"  {k}: {v}")
             elif isinstance(value, list):
-                summary_lines.append(f"{key}: {', '.join(value)}")
+                # Items aren't always strings — mutually_exclusive stores a list of
+                # groups (each a list of var names), min_behavioral a list of dicts.
+                formatted = []
+                for item in value:
+                    if isinstance(item, (list, tuple)):
+                        formatted.append("[" + ", ".join(str(v) for v in item) + "]")
+                    else:
+                        formatted.append(str(item))
+                summary_lines.append(f"{key}: {', '.join(formatted)}")
             else:
                 summary_lines.append(f"{key}: {value}")