stringjax 0.1.0__tar.gz → 0.1.1__tar.gz

stringjax-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,81 @@
+name: release
+
+# Build, check and publish the package to PyPI when a version tag `vX.Y.Z` is pushed.
+#
+# Publishing uses PyPI Trusted Publishing: no API token is stored anywhere. Once per
+# project, the PyPI project's Settings -> Publishing must name this repository (owner
+# StringJAX), the workflow file `release.yml` and the environment `pypi`.
+#
+# Release flow:
+#   1. set the version in the package metadata and date the CHANGELOG entry;
+#      commit and push to main
+#   2. git tag -a vX.Y.Z -m "<package> X.Y.Z" && git push origin vX.Y.Z
+#
+# The build job refuses a tag that differs from the built version (write the tag
+# with the normalised version, e.g. v0.2.0rc1, as in the wheel's file name).
+# Running the workflow by hand (Actions -> release -> Run workflow) builds and checks
+# without publishing, whichever branch or tag it is started on. PyPI never accepts
+# a file twice, so re-publishing an existing version fails.
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build and check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build sdist and wheel
+        run: |
+          python -m pip install --upgrade pip build twine
+          python -m build
+
+      - name: Check metadata
+        run: python -m twine check --strict dist/*
+
+      - name: The tag matches the built version
+        if: github.event_name == 'push' && github.ref_type == 'tag'
+        run: |
+          wheels=(dist/*.whl)
+          if [ "${#wheels[@]}" -ne 1 ]; then
+            echo "::error::expected one wheel, found ${#wheels[@]}"; exit 1
+          fi
+          built=$(basename "${wheels[0]}" | cut -d- -f2)
+          if [ "$built" != "${GITHUB_REF_NAME#v}" ]; then
+            echo "::error::tag $GITHUB_REF_NAME does not match the built version $built"; exit 1
+          fi
+          echo "tag $GITHUB_REF_NAME matches the built version $built"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    # only a pushed tag publishes; a manual run, even one started on a tag, does not
+    if: github.event_name == 'push' && github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # Trusted Publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

{stringjax-0.1.0 → stringjax-0.1.1}/.github/workflows/test-install.yml

@@ -3,12 +3,11 @@ 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.
+# It installs the member packages from PyPI (all are published), so it runs on pull
+# requests as well as by hand and weekly.
 
 on:
+  pull_request:
   workflow_dispatch:
   schedule:
     - cron: "0 6 * * 1"   # every Monday 06:00 UTC
@@ -19,7 +18,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.12"]
+        python-version: ["3.12", "3.13"]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-python@v5
@@ -29,6 +28,6 @@ jobs:
         run: python -m pip install .
       - name: Import the ecosystem
         run: |
-          python -c "import stringjax, jaxvacua, jaxpolylog; print(stringjax.__version__)"
+          python -c "import stringjax, jaxvacua, jaxpolylog, stringjax_tools; print(stringjax.__version__)"
       - name: Run diagnostics
         run: stringjax doctor

{stringjax-0.1.0 → stringjax-0.1.1}/.github/workflows/test.yml

@@ -12,14 +12,14 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.12"]
+        python-version: ["3.12", "3.13"]
     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
+      # require the member packages. The doctor/CLI helpers
       # are designed to work even when no member is installed.
       - name: Install (no deps) + pytest
         run: |

{stringjax-0.1.0 → stringjax-0.1.1}/.readthedocs.yaml

@@ -11,7 +11,7 @@ build:
 
 sphinx:
   configuration: documentation/source/conf.py
-  fail_on_warning: false
+  fail_on_warning: true
 
 # Install only the documentation toolchain. The hub does not import the member
 # packages, and `documentation/source/conf.py` falls back to a default version
@@ -22,5 +22,4 @@ python:
     - requirements: documentation/requirements.txt
 
 formats:
-  - pdf
   - htmlzip

stringjax-0.1.1/CHANGELOG.md

@@ -0,0 +1,52 @@
+# 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.1] - 2026-10-28
+### Changed
+- Requirements follow the released members: `jaxvacua>=0.1.3,<0.2` (the first release with the
+  `all` and `bounding` extras that `stringjax[all]` and the documentation name) and, in the `data`
+  and `all` extras, `stringforge>=0.1.3,<0.2`. The compatibility page gains a 0.1.1 row and adds
+  `stringjax-tools`; `jaxpolylog` and `stringjax-tools` are marked as coming through `jaxvacua`, which
+  sets their ranges (the 0.1.0 page's `jaxpolylog>=0.3,<0.4` was enforced by no package).
+- `stringjax doctor` lists `stringjax-tools` among the members. `float64_enabled` now reports the
+  precision a jaxvacua session runs in: JAX starts in float32 and jaxvacua switches to float64 on
+  import unless `JAXVACUA_PRECISION=float32`, so before jaxvacua is imported the value comes from that
+  variable; it used to test a bare JAX array and so reported float64 as disabled in a working
+  environment. The new `jax_enable_x64` key keeps JAX's setting as it is. A `JAXVACUA_PRECISION`
+  other than `float64` or `float32`, which jaxvacua rejects at import, is reported as such
+  (`jaxvacua_precision_invalid`). The precision hint no longer says that JAX reads
+  `JAXVACUA_PRECISION`.
+- Gurobi: the documentation and the doctor's hint state that `gurobipy` is a core dependency of
+  `jaxvacua` (its default moduli sampling uses it) whose pip wheel carries a size-limited licence,
+  instead of "everything else works without it"; if it is missing, the hint is `pip install gurobipy`.
+- Python 3.13: classifier added; the unit tests and the `test-install` workflow run on 3.12 and 3.13.
+  `test-install` (the core install from PyPI) also runs on pull requests, since the members are on
+  PyPI, and imports `stringjax_tools`. Read the Docs builds with `fail_on_warning: true` and no longer
+  builds a PDF (its LaTeX builder cannot render the ecosystem page's mermaid diagram), and the
+  documentation takes its version from `stringjax/_version.py` (it showed 0.1.0 when stringjax was
+  not installed).
+- The ecosystem page and the README list `stringjax-tools`; the ecosystem page links the jaxvacua and
+  stringforge documentation; the landing page, introduction, motivation and tutorials pages no longer
+  count "three member packages".
+
+### Added
+- Release workflow `.github/workflows/release.yml`: pushing a tag `vX.Y.Z` builds the sdist and wheel,
+  runs `twine check --strict`, refuses a tag that differs from the built version, and publishes to PyPI
+  through Trusted Publishing (no API token). Run by hand, it builds and checks without publishing.
+
+## [0.1.0] - 2026-06-11
+### 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 → stringjax-0.1.1}/CITATION.cff

@@ -1,8 +1,8 @@
 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"
+  (e.g. JAXVacua, JAXPolyLog, StringForge, StringJAX Tools) rather than this umbrella metapackage.
+title: "The StringJAX project: Compiling String Theory with JAX"
 abstract: >-
   Umbrella metapackage and tooling for the StringJAX ecosystem of differentiable
   string-theory codes.
@@ -12,9 +12,9 @@ authors:
     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"
+license: GPL-3.0-or-later
+version: 0.1.1
+date-released: "2026-10-28"
 keywords:
   - string theory
   - flux vacua

{stringjax-0.1.0 → stringjax-0.1.1}/CONTRIBUTING.md

@@ -27,7 +27,7 @@ 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
+python -m pip install -r documentation/requirements.txt   # only if building the docs
 ```
 
 ## Checks to run before opening a pull request
@@ -37,7 +37,7 @@ 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)
+sphinx-build -W -b html documentation/source documentation/build/html   # documentation build (warnings are errors)
 ```
 
 `stringjax doctor` should also run cleanly in your environment.
@@ -54,8 +54,5 @@ sphinx-build -W -b html docs docs/_build/html   # docs build (warnings are error
 ## 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).
+only when a member's compatibility window changes (see
+`documentation/source/compatibility.md`).

{stringjax-0.1.0 → stringjax-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: stringjax
-Version: 0.1.0
+Version: 0.1.1
 Summary: Umbrella metapackage and tooling for the StringJAX ecosystem of differentiable string-theory codes.
 Project-URL: Homepage, https://github.com/StringJAX
 Project-URL: Documentation, https://stringjax.readthedocs.io
@@ -17,14 +17,15 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 or later (G
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering :: Physics
 Requires-Python: >=3.12
-Requires-Dist: jaxvacua<0.2,>=0.1
+Requires-Dist: jaxvacua<0.2,>=0.1.3
 Provides-Extra: all
-Requires-Dist: jaxvacua[all]<0.2,>=0.1; extra == 'all'
-Requires-Dist: stringforge<0.2,>=0.1; extra == 'all'
+Requires-Dist: jaxvacua[all]<0.2,>=0.1.3; extra == 'all'
+Requires-Dist: stringforge<0.2,>=0.1.3; extra == 'all'
 Provides-Extra: data
-Requires-Dist: stringforge<0.2,>=0.1; extra == 'data'
+Requires-Dist: stringforge<0.2,>=0.1.3; extra == 'data'
 Provides-Extra: dev
 Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
@@ -47,9 +48,6 @@ Description-Content-Type: text/markdown
     <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3"/></a>
 </p>
 
-<!-- The Docs/PyPI badges populate once the project is published; the Python and
-     License badges are static. -->
-
 **Differentiable tools for string compactifications in JAX.**
 
 StringJAX is the umbrella project for a family of interoperating, separately
@@ -79,16 +77,17 @@ pip install "stringjax[all]"     # + databases (StringForge) and the flux-boundi
 GPU/TPU/Apple-Silicon need one extra step for JAX — see the
 [installation guide](https://stringjax.readthedocs.io/en/latest/install.html).
 
-> Note: `stringjax` is permissively licensed (MIT), but using the ecosystem pulls
-> in `jaxvacua`, which is **GPL-3.0**; your usage is subject to those terms.
+> Note: `stringjax` is released under **GPL-3.0-or-later**, matching the licence
+> of `jaxvacua`; your usage of the ecosystem is subject to those terms.
 
 ## Packages
 
 | Package        | Role                                | Install                     | Docs | GitHub |
 |----------------|-------------------------------------|-----------------------------|------|--------|
-| **JAXVacua**   | Type IIB flux-vacuum engine         | `pip install jaxvacua`      | [DOC](https://jaxvacua.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/jaxvacua)) |
-| **JAXPolyLog** | Differentiable polylogarithms       | `pip install jaxpolylog`    | [DOC](https://jaxpolylog.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/jaxpolylog)) |
-| **StringForge**| Calabi–Yau databases & vacua vault  | `pip install stringforge`   | [DOC](https://stringforge.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/stringforge)) |
+| **JAXVacua**   | Type IIB flux-vacuum engine         | `pip install jaxvacua`      | [DOC](https://jaxvacua.readthedocs.io) | ([GitHub](https://github.com/StringJAX/jaxvacua)) |
+| **JAXPolyLog** | Differentiable polylogarithms       | `pip install jaxpolylog`    | [DOC](https://jaxpolylog.readthedocs.io) | ([GitHub](https://github.com/StringJAX/jaxpolylog)) |
+| **StringForge**| Calabi-Yau databases & vacua vault  | `pip install stringforge`   | [DOC](https://stringforge.readthedocs.io) | ([GitHub](https://github.com/StringJAX/stringforge)) |
+| **StringJAX Tools** | Shared JAX transform helpers | `pip install stringjax-tools` | [DOC](https://stringjax-tools.readthedocs.io) | ([GitHub](https://github.com/StringJAX/stringjax_tools)) |
 
 `StringJAX` itself is the project/brand and is *not* an installable physics package.
 
@@ -97,17 +96,17 @@ GPU/TPU/Apple-Silicon need one extra step for JAX — see the
 ```python
 import jaxvacua as jvc
 
-jvc.set_precision("float64")                       # before heavy compute
-model  = jvc.FluxEFT(h12=2, model_ID=1, limit="LCS", maximum_degree=5)
-finder = jvc.FluxVacuaFinder.from_model(model)
-vacua  = finder.sample_SUSY_flux_vacua(N=100, mode="ISD")
+jvc.set_precision("float64")  # before heavy compute
+eft = jvc.FluxEFT(h12=2, model_ID=1, limit="LCS", maximum_degree=5)
+finder = jvc.FluxVacuaFinder.from_eft(eft)
+vacua = finder.sample_SUSY_flux_vacua(N=100, mode="ISD")
 print(len(vacua), "candidate vacua")
 ```
 
 Check your environment at any time:
 
 ```bash
-stringjax doctor      # versions, JAX backend/devices, float64 status, Gurobi availability
+stringjax doctor      # versions, JAX backend/devices, float64 status, Gurobi presence
 stringjax versions    # just the member-package versions
 ```
 
@@ -146,5 +145,4 @@ collected in the documentation.
 
 ## Contributing
 
-See [`CONTRIBUTING.md`](CONTRIBUTING.md) and the
-[code of conduct](CODE_OF_CONDUCT.md). Questions are welcome in GitHub Discussions.
+See [`CONTRIBUTING.md`](CONTRIBUTING.md). Questions are welcome in GitHub Discussions.

{stringjax-0.1.0 → stringjax-0.1.1}/README.md

@@ -7,9 +7,6 @@
     <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3"/></a>
 </p>
 
-<!-- The Docs/PyPI badges populate once the project is published; the Python and
-     License badges are static. -->
-
 **Differentiable tools for string compactifications in JAX.**
 
 StringJAX is the umbrella project for a family of interoperating, separately
@@ -39,16 +36,17 @@ pip install "stringjax[all]"     # + databases (StringForge) and the flux-boundi
 GPU/TPU/Apple-Silicon need one extra step for JAX — see the
 [installation guide](https://stringjax.readthedocs.io/en/latest/install.html).
 
-> Note: `stringjax` is permissively licensed (MIT), but using the ecosystem pulls
-> in `jaxvacua`, which is **GPL-3.0**; your usage is subject to those terms.
+> Note: `stringjax` is released under **GPL-3.0-or-later**, matching the licence
+> of `jaxvacua`; your usage of the ecosystem is subject to those terms.
 
 ## Packages
 
 | Package        | Role                                | Install                     | Docs | GitHub |
 |----------------|-------------------------------------|-----------------------------|------|--------|
-| **JAXVacua**   | Type IIB flux-vacuum engine         | `pip install jaxvacua`      | [DOC](https://jaxvacua.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/jaxvacua)) |
-| **JAXPolyLog** | Differentiable polylogarithms       | `pip install jaxpolylog`    | [DOC](https://jaxpolylog.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/jaxpolylog)) |
-| **StringForge**| Calabi–Yau databases & vacua vault  | `pip install stringforge`   | [DOC](https://stringforge.readthedocs.io) | ([GitHub](https://github.com/AndreasSchachner/stringforge)) |
+| **JAXVacua**   | Type IIB flux-vacuum engine         | `pip install jaxvacua`      | [DOC](https://jaxvacua.readthedocs.io) | ([GitHub](https://github.com/StringJAX/jaxvacua)) |
+| **JAXPolyLog** | Differentiable polylogarithms       | `pip install jaxpolylog`    | [DOC](https://jaxpolylog.readthedocs.io) | ([GitHub](https://github.com/StringJAX/jaxpolylog)) |
+| **StringForge**| Calabi-Yau databases & vacua vault  | `pip install stringforge`   | [DOC](https://stringforge.readthedocs.io) | ([GitHub](https://github.com/StringJAX/stringforge)) |
+| **StringJAX Tools** | Shared JAX transform helpers | `pip install stringjax-tools` | [DOC](https://stringjax-tools.readthedocs.io) | ([GitHub](https://github.com/StringJAX/stringjax_tools)) |
 
 `StringJAX` itself is the project/brand and is *not* an installable physics package.
 
@@ -57,17 +55,17 @@ GPU/TPU/Apple-Silicon need one extra step for JAX — see the
 ```python
 import jaxvacua as jvc
 
-jvc.set_precision("float64")                       # before heavy compute
-model  = jvc.FluxEFT(h12=2, model_ID=1, limit="LCS", maximum_degree=5)
-finder = jvc.FluxVacuaFinder.from_model(model)
-vacua  = finder.sample_SUSY_flux_vacua(N=100, mode="ISD")
+jvc.set_precision("float64")  # before heavy compute
+eft = jvc.FluxEFT(h12=2, model_ID=1, limit="LCS", maximum_degree=5)
+finder = jvc.FluxVacuaFinder.from_eft(eft)
+vacua = finder.sample_SUSY_flux_vacua(N=100, mode="ISD")
 print(len(vacua), "candidate vacua")
 ```
 
 Check your environment at any time:
 
 ```bash
-stringjax doctor      # versions, JAX backend/devices, float64 status, Gurobi availability
+stringjax doctor      # versions, JAX backend/devices, float64 status, Gurobi presence
 stringjax versions    # just the member-package versions
 ```
 
@@ -106,5 +104,4 @@ collected in the documentation.
 
 ## Contributing
 
-See [`CONTRIBUTING.md`](CONTRIBUTING.md) and the
-[code of conduct](CODE_OF_CONDUCT.md). Questions are welcome in GitHub Discussions.
+See [`CONTRIBUTING.md`](CONTRIBUTING.md). Questions are welcome in GitHub Discussions.

{stringjax-0.1.0 → stringjax-0.1.1}/documentation/requirements.txt

@@ -1,9 +1,8 @@
 # Documentation toolchain for the StringJAX hub.
 # Mirrors jaxvacua/documentation/requirements.txt so both umbrella + member
 # docs build with the same Sphinx + MyST stack.  The hub does not import the
-# member physics packages, and conf.py falls back to a default version if
-# `stringjax` itself is not installed, so the docs build even before the
-# ecosystem is published to PyPI.
+# member physics packages, and conf.py reads the version from
+# `stringjax/_version.py`, so the docs build without installing stringjax.
 tqdm
 Sphinx
 sphinx-book-theme

{stringjax-0.1.0 → stringjax-0.1.1}/documentation/source/about.md

@@ -1,7 +1,7 @@
 # About StringJAX
 
 StringJAX is an umbrella project for differentiable, JAX-native tools that study
-string compactifications — from Calabi–Yau geometry through the four-dimensional
+string compactifications — from Calabi-Yau geometry through the four-dimensional
 effective theory to moduli stabilisation and phenomenology. This page explains why
 the project exists, the principles it is built on, and where it is heading.
 
@@ -42,7 +42,7 @@ StringJAX takes a different starting point. By building every component on
 
 | Layer | Member package | Responsibility |
 |-------|----------------|----------------|
-| Geometry & data | **StringForge** | Calabi–Yau databases and the vacua vault |
+| Geometry & data | **StringForge** | Calabi-Yau databases and the vacua vault |
 | Special functions | **JAXPolyLog** | Differentiable polylogarithms / instanton sums |
 | Effective theory & vacua | **JAXVacua** | Type IIB flux-EFT construction and vacuum search |
 | Distribution | **StringJAX** | Installer, environment doctor, documentation hub |
@@ -74,12 +74,11 @@ can evolve at their own pace without coordinated "big bang" releases.
 - **Versioning.** The umbrella follows [Semantic Versioning](https://semver.org)
   and pins members to compatible ranges; see the {doc}`compatibility` matrix. A
   member's breaking change widens the umbrella's window in a new minor release.
-- **Licensing.** The `stringjax` metapackage is MIT-licensed, but installing the
-  ecosystem pulls in GPL-3.0 members (notably JAXVacua); downstream use is subject
-  to those terms. See {doc}`install`.
+- **Licensing.** The `stringjax` metapackage is released under
+  **GPL-3.0-or-later**, matching the licence of `jaxvacua`; downstream use of the
+  ecosystem is subject to those terms. See {doc}`install`.
 - **Citation.** Users cite the specific member packages they used, not the
   umbrella; see {doc}`citation`.
 - **Contributions.** Physics belongs in the member repositories; the umbrella
   accepts packaging, tooling, and documentation changes. See the project's
-  contributing guide and code of conduct.
-```
+  contributing guide.

{stringjax-0.1.0 → stringjax-0.1.1}/documentation/source/citation.md

@@ -32,7 +32,7 @@ The flux-vacuum engine. Cite the release paper and the archived software version
   title  = {{JAXPolyLog}: differentiable polylogarithms in {JAX}},
   year   = {2026},
   note   = {TODO: Zenodo DOI},
-  url    = {https://github.com/AndreasSchachner/jaxpolylog},
+  url    = {https://github.com/StringJAX/jaxpolylog},
 }
 ```
 

stringjax-0.1.1/documentation/source/compatibility.md

@@ -0,0 +1,32 @@
+# Compatibility matrix
+
+The `stringjax` metapackage installs a mutually-tested set of member packages. It
+uses **compatible version ranges** (e.g. `>=0.1,<0.2`) so that *patch* releases of a
+member require no new `stringjax` release; a new `stringjax` is published only when a
+member's compatibility window changes.
+
+| `stringjax` | `jaxvacua`   | `jaxpolylog` | `stringforge` | `stringjax-tools` | Python |
+|-------------|--------------|--------------|---------------|-------------------|--------|
+| 0.1.1       | >=0.1.3,<0.2 | >=0.4 (a)    | >=0.1.3,<0.2  | >=0.1 (a)         | >=3.12 |
+| 0.1.0       | >=0.1,<0.2   | (a)          | >=0.1,<0.2    | (a)               | >=3.12 |
+
+```{note}
+(a) `jaxpolylog`, `stringjax-tools` and `cytools` are installed transitively through
+`jaxvacua`; `stringjax` itself does not constrain them, so their ranges are those of
+the installed `jaxvacua` (from `jaxvacua` 0.1.3 on: `jaxpolylog>=0.4.0`,
+`stringjax-tools>=0.1.0`). The 0.1.0 documentation listed `jaxpolylog>=0.3,<0.4`, a
+bound that no package enforced.
+`stringforge` is installed via the `data` or `all` extras.
+```
+
+## Reproducibility
+
+For bit-stable reproduction of a specific study, install from the pinned files in the
+repository:
+
+```bash
+pip install -r requirements-cpu.txt -c constraints.txt
+```
+
+and record the output of `stringjax versions` (or `stringjax doctor`) alongside your
+results.

{stringjax-0.1.0 → stringjax-0.1.1}/documentation/source/conf.py

@@ -8,56 +8,59 @@ grid-card landing page.
 
 from __future__ import annotations
 
-from importlib.metadata import version as _v
+import re
+from pathlib import Path
 
 # -- Project information -----------------------------------------------------
-project   = "StringJAX"
-author    = "Andreas Schachner"
+project = "StringJAX"
+author = "Andreas Schachner"
 copyright = "2026, Andreas Schachner"
 
-try:
-    release = _v("stringjax")
-except Exception:  # pragma: no cover
-    release = "0.1.0"
+# The version from the source tree (``stringjax/_version.py``), not from installed metadata:
+# Read the Docs installs only the documentation requirements, and an installed stringjax
+# may be an older release.
+_version_py = Path(__file__).resolve().parents[2] / "stringjax" / "_version.py"
+_match = re.search(r'^__version__\s*=\s*"([^"]+)"', _version_py.read_text(), re.MULTILINE)
+release = _match.group(1) if _match else "0.0.0"
 version = ".".join(release.split(".")[:2])
 
 
 # -- General configuration ---------------------------------------------------
 extensions = [
-    "sphinx.ext.autodoc",             # optional autodoc for any local module
+    "sphinx.ext.autodoc",  # optional autodoc for any local module
     "sphinx.ext.autosummary",
-    "sphinx.ext.intersphinx",         # cross-link to member docs + NumPy / JAX / SciPy
+    "sphinx.ext.intersphinx",  # cross-link to member docs + NumPy / JAX / SciPy
     "sphinx.ext.mathjax",
-    "sphinx.ext.napoleon",            # NumPy / Google-style docstrings
+    "sphinx.ext.napoleon",  # NumPy / Google-style docstrings
     "sphinx_autodoc_typehints",
     "sphinx_copybutton",
     "sphinx_design",
     "sphinx_togglebutton",
     "sphinxcontrib.mermaid",
-    "myst_nb",                        # Markdown + executable notebooks
+    "myst_nb",  # Markdown + executable notebooks
 ]
 
 source_suffix = {
-    ".rst":   "restructuredtext",
-    ".md":    "myst-nb",
+    ".rst": "restructuredtext",
+    ".md": "myst-nb",
     ".ipynb": "myst-nb",
 }
 
 # The hub orients; it does not execute heavy notebooks itself.  Cell
 # outputs that ship in the .ipynb files are rendered as-is.
-nb_execution_mode         = "off"
+nb_execution_mode = "off"
 nb_execution_allow_errors = False
-nb_merge_streams          = True
-nb_execution_timeout      = 120
+nb_merge_streams = True
+nb_execution_timeout = 120
 
 myst_enable_extensions = ["colon_fence", "deflist", "linkify", "dollarmath"]
-myst_heading_anchors   = 4
+myst_heading_anchors = 4
 
 autosummary_generate = True
-napoleon_use_rtype   = False
-add_module_names     = False
+napoleon_use_rtype = False
+add_module_names = False
 
-templates_path   = ["_templates"]
+templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 suppress_warnings = [
     # member-package autodoc can emit cosmetic warnings about Google-style
@@ -67,16 +70,16 @@ suppress_warnings = [
 
 
 # -- HTML output -------------------------------------------------------------
-html_theme        = "sphinx_book_theme"
-html_title        = "StringJAX"
-html_static_path  = ["_static"]
+html_theme = "sphinx_book_theme"
+html_title = "StringJAX"
+html_static_path = ["_static"]
 html_theme_options = {
-    "repository_url":         "https://github.com/StringJAX/stringjax",
-    "repository_branch":      "main",
-    "path_to_docs":           "documentation/source",
-    "use_repository_button":  True,
-    "use_issues_button":      True,
-    "use_edit_page_button":   True,
+    "repository_url": "https://github.com/StringJAX/stringjax",
+    "repository_branch": "main",
+    "path_to_docs": "documentation/source",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
 }
 
 
@@ -91,11 +94,11 @@ mathjax3_config = {
 # Cross-references into the member packages' documentation.  Mappings are
 # enabled only when a stable ``objects.inv`` is published.
 intersphinx_mapping = {
-    "python":     ("https://docs.python.org/3",                    None),
-    "numpy":      ("https://numpy.org/doc/stable",                 None),
-    "scipy":      ("https://docs.scipy.org/doc/scipy",             None),
-    "jax":        ("https://jax.readthedocs.io/en/latest",         None),
-    "jaxpolylog": ("https://jaxpolylog.readthedocs.io/en/latest",  None),
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy", None),
+    "jax": ("https://jax.readthedocs.io/en/latest", None),
+    "jaxpolylog": ("https://jaxpolylog.readthedocs.io/en/latest", None),
     # "jaxvacua":   ("https://jaxvacua.readthedocs.io/en/latest",    None),
     # "stringforge":("https://stringforge.readthedocs.io/en/latest", None),
 }

{stringjax-0.1.0 → stringjax-0.1.1}/documentation/source/contributing.md

@@ -8,7 +8,6 @@ StringForge); this `stringjax` repository hosts only the metapackage, the
 For the full guidelines — development setup, running the tests, building the docs,
 and the pull-request checklist — see the
 [`CONTRIBUTING.md`](https://github.com/StringJAX/stringjax/blob/main/CONTRIBUTING.md)
-in the repository root and the
-[code of conduct](https://github.com/StringJAX/stringjax/blob/main/CODE_OF_CONDUCT.md).
+in the repository root.
 
 Questions and "how do I …?" discussions are best raised in GitHub Discussions.