gsax 0.1.0__tar.gz

gsax-0.1.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  # Keep the GitHub Actions used by CI / publish workflows up to date.
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      actions:
+        patterns: ["*"]

gsax-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install project and dev dependencies
+        run: uv sync --extra dev
+
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+      - name: Ruff lint
+        run: uv run ruff check .
+
+      - name: Type check
+        run: uv run ty check src/gsax
+
+      - name: Run tests
+        run: uv run pytest -q

gsax-0.1.0/.github/workflows/docs-check.yml

@@ -0,0 +1,39 @@
+name: Check Docs
+
+on:
+  pull_request:
+    paths:
+      - ".github/workflows/docs-check.yml"
+      - ".github/workflows/docs.yml"
+      - "README.md"
+      - "docs/**"
+      - "scripts/check_api_docs_coverage.py"
+      - "scripts/check_vitepress_pager.py"
+      - "src/gsax/**"
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/workflows/docs-check.yml"
+      - ".github/workflows/docs.yml"
+      - "README.md"
+      - "docs/**"
+      - "scripts/check_api_docs_coverage.py"
+      - "scripts/check_vitepress_pager.py"
+      - "src/gsax/**"
+
+jobs:
+  docs-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm ci
+        working-directory: docs
+      - run: npm run docs:check
+        working-directory: docs

gsax-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,47 @@
+name: Deploy VitePress to GitHub Pages
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    if: contains(github.event.head_commit.message, '[build docs]') || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npm ci
+        working-directory: docs
+      - run: npm run docs:check
+        working-directory: docs
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

gsax-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,48 @@
+# Publishes gsax to PyPI when a GitHub Release is published.
+#
+# Setup required once on PyPI (no API tokens needed):
+#   PyPI project -> Settings -> Publishing -> add a "trusted publisher" for
+#   owner=DanielePessina, repo=gsax, workflow=publish.yml, environment=pypi.
+# See https://docs.pypi.org/trusted-publishers/
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gsax
+    permissions:
+      id-token: write # OIDC token for PyPI trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

gsax-0.1.0/.gitignore

@@ -0,0 +1,113 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# MacOS
+.DS_Store
+
+# Aim
+.aim/
+
+# VS Code config
+.vscode/settings.json
+
+# Repomix
+.repomix/
+*.xml
+
+# Claude Code
+.claude/
+
+# Local AI-agent instructions (kept on disk, not published)
+AGENTS.md
+CLAUDE.md
+
+# Temporary files
+tmp/
+
+
+.Rproj.user
+
+# GSA simulation results (keep metadata, ignore large output files)
+scripts/results/salib_runs/**/*_sim.xlsx
+scripts/results/salib_runs/**/*_sim.csv
+scripts/results/salib_runs/**/*_sim.feather
+# scripts/results/salib_runs/**/*_sim__*.parquet
+
+### Core LaTeX files
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+.*.lb
+
+## Intermediate documents
+*.dvi
+*.xdv
+*-converted-to.*
+
+## Bibliography auxiliary files
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Build tool directories
+latex.out/
+
+## Auxiliary and intermediate files from other packages
+*.makefile
+*.idx
+*.ilg
+*.ind
+
+## Glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+*.lzo
+*.lzs
+
+## Uncomment if you don't want to keep the PDF output
+# *.pdf
+
+## Backup files
+*.backup
+*.bak
+*~
+
+## Editor-specific files
+.vscode/
+.DS_Store
+*.swp
+*.swo
+*~
+
+docs/node_modules/

gsax-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

gsax-0.1.0/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## 0.1.0
+
+Initial public release.
+
+`gsax` provides global sensitivity analysis in JAX with seven complementary
+methods:
+
+- **Sobol** indices via Saltelli sampling — first-, total-, and second-order,
+  with JAX-accelerated bootstrap confidence intervals.
+- **RS-HDMR** — B-spline surrogate with ANCOVA decomposition and a built-in
+  emulator; works with any `(X, Y)` sample pairs.
+- **PCE** — Polynomial Chaos Expansion with analytical Sobol indices and
+  leave-one-out cross-validation.
+- **eFAST** — Extended Fourier Amplitude Sensitivity Test.
+- **DGSM** — Derivative-based measures via JAX autodiff, with Poincaré-constant
+  bounds on total Sobol indices.
+- **HSIC** — Hilbert–Schmidt Independence Criterion (kernel-based dependence,
+  R2-HSIC and Total HSIC, permutation p-values).
+- **PAWN** — moment-independent, CDF-based sensitivity via Kolmogorov–Smirnov
+  distances.
+
+All methods support scalar, multi-output, and time-series outputs and export to
+labeled `xarray` Datasets.

gsax-0.1.0/CITATION.cff

@@ -0,0 +1,22 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using these metadata."
+title: "gsax: Global Sensitivity Analysis in JAX"
+abstract: >-
+  gsax computes global sensitivity indices entirely in JAX, providing Sobol,
+  RS-HDMR, PCE, eFAST, DGSM, HSIC, and PAWN methods with GPU/TPU acceleration.
+type: software
+authors:
+  - family-names: Pessina
+    given-names: Daniele
+    email: danielepessina99@gmail.com
+version: 0.1.0
+date-released: "2026-07-09"
+license: MIT
+repository-code: "https://github.com/DanielePessina/gsax"
+url: "https://danielepessina.github.io/gsax/"
+keywords:
+  - sensitivity-analysis
+  - global-sensitivity-analysis
+  - sobol
+  - jax
+  - uncertainty-quantification

gsax-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to gsax
+
+Thanks for your interest in improving gsax! This guide covers the local setup
+and the checks a pull request is expected to pass.
+
+## Development setup
+
+gsax uses [uv](https://docs.astral.sh/uv/) for environment and dependency
+management.
+
+```bash
+git clone https://github.com/DanielePessina/gsax.git
+cd gsax
+uv sync --extra dev
+```
+
+## Before opening a pull request
+
+Run the same checks CI runs, and make sure they all pass:
+
+```bash
+uv run ruff format .          # format
+uv run ruff check .           # lint
+uv run ty check src/gsax      # type-check
+uv run pytest                 # tests
+```
+
+Please also:
+
+- Add or update tests for any behaviour you change.
+- Keep public APIs documented with Google-style docstrings.
+- Update `CHANGELOG.md` under the unreleased section when user-facing behaviour
+  changes.
+- If you touch the public API, run `uv run python scripts/check_api_docs_coverage.py`
+  so the reference docs stay complete.
+
+## Reporting issues
+
+Please open an issue with a minimal reproducible example, the gsax version, and
+your Python/JAX versions.

gsax-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Daniele Pessina
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.