stringjax 0.1.0__tar.gz

stringjax-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,32 @@
+name: Bug report
+description: Report a problem with the stringjax metapackage, installer, or docs.
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        For problems with a member package's physics or API, please open the issue
+        in that package's repository (e.g. StringJAX/jaxvacua).
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear description of the problem and what you expected instead.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Minimal commands or code that trigger the issue.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: doctor
+    attributes:
+      label: Output of `stringjax doctor`
+      description: Paste the full output. This captures versions, JAX backend, and precision.
+      render: text
+    validations:
+      required: true

stringjax-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Question / discussion
+    url: https://github.com/orgs/StringJAX/discussions
+    about: Ask "how do I …?" questions and discuss usage here.
+  - name: JAXVacua issues
+    url: https://github.com/StringJAX/jaxvacua/issues
+    about: Report problems with the flux-vacuum engine in its own repository.

stringjax-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,24 @@
+name: Feature request
+description: Suggest an improvement to the stringjax metapackage, installer, or hub.
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem / motivation
+      description: What are you trying to do, and what is currently awkward or missing?
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: Describe the change you would like to see.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives considered
+    validations:
+      required: false

stringjax-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!-- Thanks for contributing to StringJAX! -->
+
+## Summary
+
+<!-- What does this PR change, and why? -->
+
+## Type of change
+- [ ] Bug fix
+- [ ] New feature
+- [ ] Documentation
+- [ ] Dependency / version-range update
+- [ ] Other
+
+## Checklist
+- [ ] This change belongs in the `stringjax` umbrella (not a member repo).
+- [ ] `ruff check`, `ruff format --check`, and `mypy` pass.
+- [ ] Docs build with `sphinx-build -W` (if docs changed).
+- [ ] `CHANGELOG.md` updated under *Unreleased*.
+- [ ] Compatibility matrix updated (if dependency ranges changed).

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

@@ -0,0 +1,26 @@
+name: docs
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      # Install only the documentation toolchain; the hub does not import the member
+      # packages, and conf.py falls back to a default version if stringjax is absent.
+      - name: Install docs dependencies
+        run: python -m pip install -r documentation/requirements.txt
+      - name: Build HTML (warnings are errors)
+        run: sphinx-build -W -b html documentation/source documentation/_build/html
+      # Link checking depends on third-party sites being reachable, so a failure
+      # here is informational and must not block a pull request.
+      - name: Link check
+        continue-on-error: true
+        run: sphinx-build -b linkcheck documentation/source documentation/_build/linkcheck

stringjax-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      # Tools only: the metapackage's own quality checks do not require the (possibly
+      # unpublished) member packages to be installed.
+      - name: Install tooling
+        run: python -m pip install ruff mypy
+      - name: Ruff (lint)
+        run: ruff check .
+      - name: Ruff (format)
+        run: ruff format --check .
+      - name: mypy
+        run: mypy stringjax

stringjax-0.1.0/.github/workflows/test-install.yml

@@ -0,0 +1,34 @@
+name: test-install
+
+# Full-ecosystem install check: verifies that the metapackage resolves and installs
+# a coherent set of member packages, and that the environment helper runs.
+#
+# NOTE: this requires the member packages (jaxvacua, jaxpolylog, ...) to be available
+# on PyPI. Until they are published it is run manually / on a schedule only, so that
+# ordinary pull requests are not blocked. Re-enable `pull_request` once the members
+# are released.
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 6 * * 1"   # every Monday 06:00 UTC
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install (core)
+        run: python -m pip install .
+      - name: Import the ecosystem
+        run: |
+          python -c "import stringjax, jaxvacua, jaxpolylog; print(stringjax.__version__)"
+      - name: Run diagnostics
+        run: stringjax doctor

stringjax-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,29 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  unit:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # Install the metapackage WITHOUT its dependencies so the unit tests do not
+      # require the (possibly unpublished) member packages. The doctor/CLI helpers
+      # are designed to work even when no member is installed.
+      - name: Install (no deps) + pytest
+        run: |
+          python -m pip install -e . --no-deps
+          python -m pip install pytest
+      - name: Run unit tests
+        run: pytest -q

stringjax-0.1.0/.gitignore

@@ -0,0 +1,25 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+private/
+
+# Tooling
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+
+# Docs
+docs/_build/
+docs/api/        # auto-generated by sphinx-autoapi
+
+# OS / editors
+.DS_Store
+*.swp
+.idea/
+.vscode/

stringjax-0.1.0/.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Read the Docs build configuration for the StringJAX documentation hub.
+#
+# Layout mirrors jaxvacua: `documentation/` is the build root with a
+# `source/` subdirectory and a sibling `requirements.txt`.
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: documentation/source/conf.py
+  fail_on_warning: false
+
+# Install only the documentation toolchain. The hub does not import the member
+# packages, and `documentation/source/conf.py` falls back to a default version
+# if `stringjax` is not installed -- so the docs build even before the
+# ecosystem is published to PyPI.
+python:
+  install:
+    - requirements: documentation/requirements.txt
+
+formats:
+  - pdf
+  - htmlzip

stringjax-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to the `stringjax` metapackage are documented here. The format
+follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-01-01
+### Added
+- Initial release of the `stringjax` umbrella metapackage.
+- Dependency aggregation for the ecosystem: `jaxvacua` (core), with `data`
+  (`stringforge`) and `all` extras.
+- `stringjax doctor` and `stringjax versions` command-line helpers, plus the
+  `stringjax.report()` diagnostics API.
+- Documentation hub skeleton (Sphinx + MyST).
+
+[Unreleased]: https://github.com/StringJAX/stringjax/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/StringJAX/stringjax/releases/tag/v0.1.0

stringjax-0.1.0/CITATION.cff

@@ -0,0 +1,23 @@
+cff-version: 1.2.0
+message: >-
+  If you use the StringJAX ecosystem, please cite the specific package(s) you used
+  (e.g. JAXVacua, JAXPolyLog, StringForge) rather than this umbrella metapackage.
+title: "StringJAX: differentiable, JAX-native tools for string compactifications"
+abstract: >-
+  Umbrella metapackage and tooling for the StringJAX ecosystem of differentiable
+  string-theory codes.
+type: software
+authors:
+  - family-names: Schachner
+    given-names: Andreas
+repository-code: "https://github.com/StringJAX/stringjax"
+url: "https://stringjax.readthedocs.io"
+license: MIT
+version: 0.1.0
+date-released: "2026-01-01"
+keywords:
+  - string theory
+  - flux vacua
+  - JAX
+  - Calabi-Yau
+  - moduli stabilisation

stringjax-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to StringJAX
+
+Thank you for considering a contribution! This repository hosts the `stringjax`
+metapackage (a one-command installer, the `stringjax` command, and the documentation
+hub). **Physics contributions belong in the member repositories** — JAXVacua,
+JAXPolyLog, StringForge.
+
+## Where should my contribution go?
+
+- A new feature, bug fix, or docs for the flux-vacuum engine → **JAXVacua**.
+- Polylogarithm functionality → **JAXPolyLog**.
+- Datasets / data access → **StringForge**.
+- Installation, the `stringjax` command, the ecosystem hub, or version pins → here.
+
+## Development setup
+
+```bash
+git clone https://github.com/StringJAX/stringjax
+cd stringjax
+python -m pip install -e ".[dev,docs]"
+```
+
+If you only need to work on the metapackage itself (the `stringjax` command, the
+hub, the version pins) and the member packages are not yet published, install
+without dependencies and add the tooling directly:
+
+```bash
+python -m pip install -e . --no-deps
+python -m pip install ruff mypy pytest
+python -m pip install -r docs/requirements.txt   # only if building the docs
+```
+
+## Checks to run before opening a pull request
+
+```bash
+ruff check .            # lint
+ruff format --check .   # formatting
+mypy src/stringjax      # type checks
+pytest                  # tests (if present)
+sphinx-build -W -b html docs docs/_build/html   # docs build (warnings are errors)
+```
+
+`stringjax doctor` should also run cleanly in your environment.
+
+## Pull-request checklist
+
+- [ ] The change is in the correct repository (member vs umbrella).
+- [ ] Lint, format, and type checks pass.
+- [ ] Documentation updated where relevant (including the compatibility matrix if
+      dependency ranges change).
+- [ ] `CHANGELOG.md` updated under *Unreleased*.
+- [ ] Commits are focused and descriptively messaged.
+
+## Versioning
+
+The metapackage follows [Semantic Versioning](https://semver.org). Bump the version
+only when a member's compatibility window changes (see `docs/compatibility.md`).
+
+## Code of conduct
+
+By participating you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).