samba-core 5.3.1__tar.gz

samba_core-5.3.1/.dockerignore

@@ -0,0 +1,23 @@
+# Keep the build context small and reproducible.
+.git
+.github
+.venv
+__pycache__/
+*.pyc
+.mypy_cache
+.pytest_cache
+.ruff_cache
+
+# Not needed in the service image
+tests
+planning
+docs
+examples
+ui
+scripts
+working
+artifacts
+results
+_reference
+*.md
+!README.md

samba_core-5.3.1/.env.example

@@ -0,0 +1,23 @@
+# SAMBA environment variables — copy to `.env` and fill in your values.
+#   cp .env.example .env   # then edit .env (it is git-ignored; never commit it)
+#
+# SAMBA's CLI auto-loads a local `.env` (values already in your shell win).
+
+# --- NREL NSRDB weather fetch (weather.source: "nsrdb" / `samba fetch-weather`) ---
+# Get a free key at https://developer.nlr.gov/signup/
+NREL_API_KEY=your-nrel-api-key-here
+NREL_API_EMAIL=you@example.com
+
+# Optional: override the on-disk weather cache directory (default ~/.cache/samba/weather)
+# SAMBA_WEATHER_CACHE=/path/to/weather/cache
+
+# --- REST service (samba serve / Docker) — all optional; see docs/deployment.md ---
+# SAMBA_HOST=127.0.0.1
+# SAMBA_PORT=8000
+# SAMBA_RUN_DIR=results
+# SAMBA_DATA_DIR=.
+# SAMBA_API_KEY=             # set to require an X-API-Key header on the API
+# SAMBA_CORS_ORIGINS=*
+# SAMBA_MAX_CONCURRENT=4
+# SAMBA_JOB_TTL_HOURS=24
+# SAMBA_PERSIST_JOBS=0       # 1 = SQLite-backed job store that survives restart

samba_core-5.3.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,61 @@
+name: Bug report
+description: Report something that isn't working as expected
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for filing a bug. Please search existing issues first, and do
+        not report security issues here — see the security policy.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear description of the bug, including what you expected instead.
+    validations:
+      required: true
+  - type: textarea
+    id: repro
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps — ideally a small scenario YAML and the command or API call used.
+      placeholder: |
+        1. ...
+        2. ...
+      render: shell
+    validations:
+      required: true
+  - type: dropdown
+    id: interface
+    attributes:
+      label: Interface
+      description: Which way were you using SAMBA?
+      options:
+        - CLI
+        - Python API
+        - REST service (samba serve)
+        - Desktop / Web UI
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: SAMBA version / commit
+      description: Output of `samba info`, a release version, or a commit SHA.
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Environment
+      description: OS, install method (pip / uv / source), and Python/Node versions if relevant.
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs / output
+      description: Solver output, traceback, or a relevant `kpis.json` snippet.
+      render: shell
+    validations:
+      required: false

samba_core-5.3.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://github.com/sambaenergies/samba/tree/main/docs
+    about: Getting started, scenario reference, and CLI/API guides.
+  - name: Security vulnerability
+    url: https://github.com/sambaenergies/samba/security/advisories/new
+    about: Report security issues privately — do not open a public issue.

samba_core-5.3.1/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,25 @@
+name: Feature request
+description: Suggest a capability or improvement
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem / motivation
+      description: What are you trying to do that SAMBA doesn't support today?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: What you'd like to see — a new component, tariff type, KPI, CLI/API option, etc.
+    validations:
+      required: false
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives & context
+      description: Workarounds you've tried, other approaches, references (papers, other tools), or example scenarios.
+    validations:
+      required: false

samba_core-5.3.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+## Summary
+
+- What changed and why.
+
+## Validation
+
+- [ ] `just check` (ruff + mypy + schema drift gate)
+- [ ] Relevant `pytest` scope run and passed
+- [ ] For UI changes: `just ui-check` (gen:types drift + lint + vue-tsc + vitest)
+
+## UI/UX Checklist (for UI-affecting PRs)
+
+- [ ] Loading/empty/error states implemented for new async UI panels
+- [ ] Keyboard accessibility verified for new controls
+- [ ] Screenshots/GIFs added for UI changes
+
+## Notes
+
+- Risks, trade-offs, follow-ups.

samba_core-5.3.1/.github/workflows/ci.yml

@@ -0,0 +1,85 @@
+name: CI
+
+# Unified gate: CI runs the exact same `just` recipes developers run locally, so
+# the pipeline cannot drift from `just check` / `just ui-check` / `just test`.
+# `just` is installed via uv (the `rust-just` distribution) — no extra toolchain.
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  check:
+    name: Check (ruff + mypy + schema drift)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: just check
+        run: uvx --from rust-just just check
+
+  test:
+    name: Test (Python ${{ matrix.python-version }}, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+        exclude:
+          - os: windows-latest
+            python-version: "3.13"
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+          python-version: "${{ matrix.python-version }}"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      # `just test` body, run directly to stay portable on the Windows runner
+      # (avoids relying on a POSIX shell for the recipe).
+      - name: Test
+        run: uv run pytest
+
+  ui:
+    name: UI (just ui-check)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+          cache: npm
+          cache-dependency-path: ui/package-lock.json
+
+      - name: Install UI dependencies
+        run: npm ci
+        working-directory: ui
+
+      - name: Install uv (for just)
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+
+      # just ui-check: gen:types drift gate + eslint + vue-tsc + vitest
+      - name: just ui-check
+        run: uvx --from rust-just just ui-check

samba_core-5.3.1/.github/workflows/goldens.yml

@@ -0,0 +1,43 @@
+name: Golden Scenarios
+
+on:
+  schedule:
+    - cron: "0 3 * * *"   # 03:00 UTC nightly
+  push:
+    branches: [main]
+    paths:
+      - "samba/**"
+      - "tests/goldens/**"
+  workflow_dispatch:
+
+jobs:
+  goldens:
+    name: Goldens (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+          python-version: "${{ matrix.python-version }}"
+
+      - name: Install SAMBA and dev dependencies
+        run: uv sync --extra cli
+
+      - name: Run golden scenarios
+        run: uv run pytest tests/goldens/ -m benchmark --tb=short -q
+
+      - name: Upload golden output on failure
+        if: failure()
+        uses: actions/upload-artifact@v7
+        with:
+          name: golden-failure-py${{ matrix.python-version }}
+          path: tests/goldens/**/output/
+          if-no-files-found: ignore

samba_core-5.3.1/.github/workflows/release.yml

@@ -0,0 +1,86 @@
+name: Release
+
+# Tag a release (`git tag vX.Y.Z && git push --tags`) to build and publish
+# `samba-core` to PyPI via OIDC Trusted Publishing (no API token). Manually
+# dispatching the workflow instead publishes to TestPyPI for a dry run.
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+        with:
+          enable-cache: true
+
+      - name: Build sdist + wheel
+        run: uv build
+
+      - name: Check distribution metadata
+        run: uvx twine check dist/*
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI (dry run)
+    if: github.event_name == 'workflow_dispatch'
+    needs: build
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      id-token: write # OIDC for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # OIDC for Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: Create GitHub release
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # create the release + upload assets
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+      - uses: softprops/action-gh-release@v3
+        with:
+          files: dist/*
+          generate_release_notes: true

samba_core-5.3.1/.gitignore

@@ -0,0 +1,230 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.env.*
+!.env.example
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# SAMBA run outputs (root-level only; does not affect samba/run_result/ source package)
+/results/
+
+# SAMBA scratch / debug dumps
+test_after_*.txt
+
+# ignore generated artifact from profiling, debug, and other experimental runs
+artifacts/
+# Local-only vendored upstream reference tree — kept locally for one-off
+# comparison only, never tracked or shipped.
+_reference/
+
+# Internal working/design notes and roadmap — kept locally, not published.
+planning/
+working/
+
+# COP dataset fetched from third-party sources (verify license before committing)
+cop_dataset.csv
+*.raw.csv
+TODO.md

samba_core-5.3.1/.markdownlint.json

@@ -0,0 +1,11 @@
+{
+  "default": true,
+  "MD013": false,
+  "MD004": { "style": "dash" },
+  "MD024": { "siblings_only": true },
+  "MD033": false,
+  "MD036": false,
+  "MD040": false,
+  "MD041": false,
+  "MD060": false
+}

samba_core-5.3.1/.markdownlintignore

@@ -0,0 +1,4 @@
+# Internal planning / historical scratch notes — local only, not published.
+planning/
+# Local-only vendored reference tree (git-ignored).
+_reference/

samba_core-5.3.1/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml