Publish HamiltonZero 0.1.1 package

README.md

@@ -14,12 +14,21 @@ wavefunctions of quantum spin Hamiltonians. It exposes three workflows:
 
 ## Installation
 
-HamiltonZero requires Python 3.12 and JAX-compatible accelerator drivers.
+HamiltonZero requires Python 3.12 or newer and JAX-compatible accelerator
+drivers.
 
 ```bash
-python -m pip install .
+python -m pip install hamiltonzero
 ```
 
+To install from a source checkout instead, run `python -m pip install .` in
+the repository root.
+
+Example configurations and research datasets are repository assets rather
+than wheel data. Clone the matching
+[`v0.1.1` source tree](https://github.com/simulacra-research/HamiltonZero/tree/v0.1.1)
+to run the documented commands unchanged.
+
 The package pins `jax==0.11.0` and `jaxlib==0.11.0`. Install the accelerator
 plugin appropriate for the host using the standard JAX instructions.
 
@@ -71,10 +80,9 @@ does this from the input system automatically.
 
 The public API follows the textbook convention
 
-\[
-H = \sum_{i<j} S_i^T J_{ij} S_j + \sum_i h_i^T S_i,
-\qquad S=\sigma/2.
-\]
+```text
+H = sum_(i<j) S_i^T J_ij S_j + sum_i h_i^T S_i,  S = sigma/2.
+```
 
 Construct and save a system from a simple undirected NetworkX graph:
 
@@ -153,8 +161,8 @@ There is no additional bit reversal: applying one would corrupt the mapping.
 Both arrays include padded virtual leaves when the model width exceeds the
 physical site count. A complete runnable version that prints sample means and
 standard deviations is in
-[`examples/compiled_inference.py`](examples/compiled_inference.py).
-[`examples/j1j2_4x4_route.ipynb`](examples/j1j2_4x4_route.ipynb) constructs a
+[`examples/compiled_inference.py`](https://github.com/simulacra-research/HamiltonZero/blob/v0.1.1/examples/compiled_inference.py).
+[`examples/j1j2_4x4_route.ipynb`](https://github.com/simulacra-research/HamiltonZero/blob/v0.1.1/examples/j1j2_4x4_route.ipynb) constructs a
 periodic 4-by-4 J1-J2 model from NetworkX and visualizes the returned order as
 the successive cells of the compiled binary merge tree. Install its plotting
 dependencies with `python -m pip install '.[notebooks]'`.
@@ -206,7 +214,7 @@ public textbook units above.
   spins.
 
 Large-N files store physical sites only; the loader reconstructs power-of-two
-padding in memory. See [`datasets/README.md`](datasets/README.md) for the full
+padding in memory. See [`datasets/README.md`](https://github.com/simulacra-research/HamiltonZero/blob/v0.1.1/datasets/README.md) for the full
 inventory and sparse exchange encoding.
 
 ## Train
@@ -303,4 +311,4 @@ licensed under Apache-2.0, copyright Simulacra Research Inc. The vendored
 KFAC-JAX fork and JAX-derived large-N attention kernel remain under
 Apache-2.0. The Microsoft-Folx-derived attention forward and reverse-mode
 kernels remain under MIT. See
-[`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md).
+[`THIRD_PARTY_NOTICES.md`](https://github.com/simulacra-research/HamiltonZero/blob/v0.1.1/THIRD_PARTY_NOTICES.md).

pyproject.toml

@@ -4,10 +4,25 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hamiltonzero"
-version = "0.1.0"
+version = "0.1.1"
 description = "Compiled neural wavefunctions for quantum spin systems"
 readme = "README.md"
 requires-python = ">=3.12"
+authors = [
+    {name = "Simulacra Research Inc."},
+]
+keywords = [
+    "neural quantum states",
+    "quantum many-body physics",
+    "quantum Monte Carlo",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Physics",
+]
 license = "Apache-2.0 AND MIT"
 license-files = [
     "LICENSE",
@@ -33,6 +48,12 @@ dependencies = [
     "typing-extensions>=4.15",
 ]
 
+[project.urls]
+Homepage = "https://github.com/simulacra-research/HamiltonZero"
+Repository = "https://github.com/simulacra-research/HamiltonZero"
+Issues = "https://github.com/simulacra-research/HamiltonZero/issues"
+"Model weights" = "https://huggingface.co/simulacra-research/HamiltonZero"
+
 [project.optional-dependencies]
 notebooks = [
     "jupyterlab>=4.4",