Fix/dunder hash contract

.gitattributes

@@ -0,0 +1,2 @@
+steer_core/Data/database.db filter=lfs diff=lfs merge=lfs -text
+/steer_core/Data/database.db filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -8,3 +8,4 @@ data_scripts/
 local_data/
 Archive/
 .vscode*
+app_builds/

.vscode/settings.json

@@ -7,5 +7,15 @@
         "test*.py"
     ],
     "python.testing.pytestEnabled": false,
-    "python.testing.unittestEnabled": true
+    "python.testing.unittestEnabled": true,
+    "python-envs.defaultEnvManager": "ms-python.python:conda",
+    "python-envs.defaultPackageManager": "ms-python.python:conda",
+    "python-envs.pythonProjects": [],
+    "python.analysis.extraPaths": [
+        "/Users/nsiemons/Drive/Code_projects/STEER/steer-core",
+        "/Users/nsiemons/Drive/Code_projects/STEER/steer-opencell-data",
+        "/Users/nsiemons/Drive/Code_projects/STEER/steer-opencell-design",
+        "/Users/nsiemons/Drive/Code_projects/STEER/steer-materials",
+        "/Users/nsiemons/Drive/Code_projects/STEER/steer-dash-components"
+    ],
 }

LICENSE

@@ -0,0 +1,43 @@
+Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
+
+Copyright (c) 2026 Nicholas Siemons
+
+This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
+
+To view a copy of this license, visit:
+http://creativecommons.org/licenses/by-nc-sa/4.0/
+
+or send a letter to:
+Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+
+===============================================================================
+
+You are free to:
+
+  * Share — copy and redistribute the material in any medium or format
+  * Adapt — remix, transform, and build upon the material
+
+The licensor cannot revoke these freedoms as long as you follow the license terms.
+
+Under the following terms:
+
+  * Attribution — You must give appropriate credit, provide a link to the license,
+    and indicate if changes were made. You may do so in any reasonable manner, but
+    not in any way that suggests the licensor endorses you or your use.
+
+  * NonCommercial — You may not use the material for commercial purposes.
+
+  * ShareAlike — If you remix, transform, or build upon the material, you must
+    distribute your contributions under the same license as the original.
+
+  * No additional restrictions — You may not apply legal terms or technological
+    measures that legally restrict others from doing anything the license permits.
+
+Notices:
+
+You do not have to comply with the license for elements of the material in the
+public domain or where your use is permitted by an applicable exception or limitation.
+
+No warranties are given. The license may not give you all of the permissions necessary
+for your intended use. For example, other rights such as publicity, privacy, or moral
+rights may limit how you use the material.

README.md

@@ -0,0 +1,83 @@
+# steer-core
+
+Base utilities for the OpenCell platform: constants, mixins (Serializer, Validation, Plotter), decorators, and the DataManager REST API client.
+
+## Install
+
+```bash
+pip install -e .
+```
+
+## Environment Variables
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `OPENCELL_ENV` | No | `production` | `development` = local SQLite, no auth. `production` = REST API + Cognito auth. |
+| `API_URL` | In production | — | Base URL of the deployed REST API (e.g. `https://59xitvvsf2.execute-api.us-east-2.amazonaws.com/production`) |
+| `API_TIMEOUT` | No | `30` | HTTP request timeout in seconds |
+
+## Development vs Production Mode
+
+Controlled by the `OPENCELL_ENV` environment variable. The helper `is_development()` from `steer_core.Data` is the single source of truth — use it anywhere you need to branch on mode.
+
+```python
+from steer_core.Data import is_development
+
+if is_development():
+    # local SQLite path
+else:
+    # REST API path
+```
+
+### Development mode (`OPENCELL_ENV=development`)
+
+- `SerializerMixin.from_database()` uses the local SQLite database via `steer_opencell_data.DataManager`
+- No network calls, works fully offline
+- Requires `steer-opencell-data` installed with `database.db`
+- Use this when developing new cells locally before publishing via the CLI migration tool (`steer-opencell-data` CLI)
+
+### Production mode (`OPENCELL_ENV=production` or unset)
+
+- `SerializerMixin.from_database()` uses the REST API via `steer_core.Data.DataManager`
+- Requires `API_URL` pointing to the deployed Lambda endpoint
+- JWT token passed automatically for authenticated operations (`DataManager.set_token()`)
+- Logs API calls and S3 downloads to the `steer_core.DataManager` logger
+
+## DataManager REST Client
+
+`steer_core.Data.DataManager` — drop-in replacement for the SQLite-based DataManager. Same interface, talks to the REST API + S3 instead.
+
+### Key methods
+
+| Method | What it does |
+|--------|-------------|
+| `get_data(table, condition="name='X'")` | Fetch item + download blob from S3 presigned URL |
+| `get_data(table)` (no condition) | List items — metadata only, no blob |
+| `get_unique_values(table, column)` | List unique values from API |
+| `get_{type}_materials(most_recent)` | 9 material-specific convenience methods |
+| `insert_data(table, df)` | Upload blob to S3 via presigned URL |
+| `remove_data(table, condition)` | Soft-delete via API |
+| `fork_cell(table, name, new_name)` | Fork cell (auth required) |
+| `publish_cell(table, name, new_name)` | Publish cell (admin only) |
+| `check_name_available(name)` | Check name uniqueness across all cell tables |
+| `set_token(token)` | Set JWT for authenticated requests |
+
+### Exceptions
+
+| Exception | HTTP Status | When |
+|-----------|-------------|------|
+| `DataManagerError` | — | Base class / missing `API_URL` |
+| `APIError` | 5xx | Server error |
+| `AuthenticationError` | 401 | Missing or invalid token |
+| `ForbiddenError` | 403 | Insufficient permissions |
+| `NotFoundError` | 404 | Resource not found |
+| `ConflictError` | 409 | Name already taken (fork/publish) |
+
+### Logging
+
+API calls and S3 downloads are logged to the `steer_core.DataManager` logger:
+
+```
+[steer_core.DataManager] [API] GET /materials/tape_materials/Kapton -> 200 (164 ms)
+[steer_core.DataManager] [S3] Downloaded 0.2 KB in 499 ms
+```

pyproject.toml

@@ -0,0 +1,110 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "steer-core"
+dynamic = ["version"]
+description = "Modelling energy storage from cell to site - STEER OpenCell Design"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "CC-BY-NC-SA-4.0"}
+authors = [
+    {name = "Nicholas Siemons", email = "nsiemons@stanford.edu"},
+]
+maintainers = [
+    {name = "Nicholas Siemons", email = "nsiemons@stanford.edu"},
+]
+keywords = ["energy", "storage", "battery", "modeling", "simulation"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "License :: Other/Proprietary License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Scientific/Engineering :: Physics",
+]
+dependencies = [
+    "pandas==2.3.3",
+    "numpy==2.2.6",
+    "datetime==5.5",
+    "plotly==6.2.0",
+    "scipy==1.15.3",
+    "msgpack==1.1.1",
+    "msgpack-numpy==0.4.8",
+    "requests>=2.31.0",
+    "nbformat==5.10.4",
+    "shapely==2.1.1",
+    "lz4==4.4.4"
+]
+
+[project.urls]
+Homepage = "https://github.com/nicholas9182/steer-core/"
+Repository = "https://github.com/nicholas9182/steer-core/"
+Issues = "https://github.com/nicholas9182/steer-core/issues"
+Documentation = "https://github.com/nicholas9182/steer-core/"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "black",
+    "flake8",
+    "mypy",
+    "isort",
+]
+test = [
+    "pytest>=7.0",
+    "pytest-cov",
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["steer_core*"]
+
+[tool.setuptools.package-data]
+"steer_core.Data" = ["*.py"]
+
+[tool.setuptools.dynamic]
+version = {attr = "steer_core.__version__"}
+
+[tool.black]
+line-length = 88
+target-version = ['py310']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # directories
+  \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | build
+  | dist
+)/
+'''
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+line_length = 88
+known_first_party = ["steer_core"]
+
+[tool.pytest.ini_options]
+minversion = "7.0"
+addopts = "-ra -q --strict-markers"
+testpaths = [
+    "test",
+]
+python_files = [
+    "test_*.py",
+    "*_test.py",
+]