FastLSQ 0.6.0__tar.gz → 0.6.2__tar.gz

{fastlsq-0.6.0 → fastlsq-0.6.2}/CHANGELOG.md

@@ -2,6 +2,231 @@
 
 All notable changes to FastLSQ will be documented in this file.
 
+## Release tags
+
+Every released version is tagged `vMAJOR.MINOR.PATCH`.  The tags for 0.1.0 through
+0.6.0 were **reconstructed in September 2026**: the project was published to PyPI for
+its first year with only one tag (`v0.2.2`) ever created by hand.
+
+Each tag was placed by comparing the `fastlsq/*.py` sources at every commit in the
+repository against the sdist actually published to PyPI, not by guessing from dates.
+Fourteen of the seventeen published releases matched a commit byte for byte.  The one
+pre-existing tag, `v0.2.2`, was left untouched and independently resolved to the same
+commit the reconstruction chose, which is the main evidence that the method is sound.
+
+Three tags are **approximate**, and their tag messages say so:
+
+| Version | What is wrong | Authoritative artefact |
+|---|---|---|
+| 0.1.2 | The published sdist contains `fastlsq/problems/apebench.py`, which exists in no commit in this repository | `fastlsq-0.1.2.tar.gz` on PyPI |
+| 0.1.3 | Same file, same problem | `fastlsq-0.1.3.tar.gz` on PyPI |
+| 0.1.5 | The published `fastlsq/problems/linear.py` is ahead of every committed version of that file | `fastlsq-0.1.5.tar.gz` on PyPI |
+
+All three were released from a working tree holding source that was never committed.
+For those versions the sdist on PyPI is the record, not the tag.
+
+### Zenodo archives
+
+Every tag is archived on Zenodo under concept DOI
+[10.5281/zenodo.22830737](https://doi.org/10.5281/zenodo.22830737).
+
+Two things about that archive are worth knowing, because neither is obvious:
+
+- **Zenodo reads `.zenodo.json` from the tagged commit's tree, not from `main`.**
+  No tag before 0.6.2 contained the file, so every archived version up to and
+  including 0.6.1 carries GitHub's auto-generated metadata -- the title
+  `sulcantonin/FastLSQ: FastLSQ <version>`, no ORCID, no affiliation, no keywords
+  and no link to the preprint.
+- **Zenodo's "latest version" is the one published last, not the highest version
+  number.** The twenty releases were archived in parallel and finished out of
+  order, so the concept DOI resolved to 0.2.6 for a while. Cutting a new release is
+  what corrects it.
+
+### Versions documented here that were never released
+
+- **0.2.0** (dated 2026-03-01 below) was never on PyPI and `pyproject.toml` never
+  declared it. The published sequence runs 0.1.4 → 0.1.5 → 0.2.1. There is no `v0.2.0`
+  tag. The entry is kept for the history of the work, not as a release.
+- **0.4.3** and **0.5.0** are real code milestones on `main` -- `pyproject.toml`
+  declares each -- but neither was uploaded. The published sequence runs 0.4.2
+  (2026-07-20) straight to 0.6.0 (2026-07-21). Both are tagged, and both tags say
+  `NEVER PUBLISHED TO PyPI`.
+
+### Releases missing from this file
+
+**0.1.1, 0.1.2, 0.1.3 and 0.1.4 were published to PyPI but have no entry below.**
+They are tagged, and their scope can be read from the tags and the commit history, but
+this file jumps 0.1.0 → 0.2.0 → 0.1.5 and does not describe them. Reconstructing four
+changelog entries a year after the fact would be invention rather than record, so the
+gap is documented here instead of filled in.
+
+## [0.6.2] - 2026-09-18
+
+Packaging, citation and repository metadata. **No change to `fastlsq/`** -- the
+importable library is byte-identical to 0.6.1, and the wheel is unchanged. The
+sdist gains one example and its test.
+
+### Added
+
+- **`examples/stealth_navigation.py`** -- a FastLSQ world model refit inside a
+  control loop. A drone crosses a radar interference field sensing only a
+  five-point cross at its own position; every three steps it refits a surrogate
+  over everything sensed so far (one Tikhonov least-squares solve, 6.1 ms median)
+  and steers on that surrogate's *analytic* gradient. The ablation is the
+  argument: with the gradient term off, driving straight at the goal trips the
+  detector at step 133 of an otherwise 275-step crossing.
+
+  `tests/test_stealth_navigation.py` checks the analytic gradient against finite
+  differences and asserts the ablation in both directions.
+
+  The project website quoted figures for this demo, but no script in the
+  repository produced them. Now the numbers are output rather than assertion.
+
+- **Citation and archive metadata.** `CITATION.cff` drives GitHub's *Cite this
+  repository* widget, with `preferred-citation` pointing at the paper.
+  `.zenodo.json` describes the Zenodo deposit -- title, abstract, ORCID,
+  affiliation, keywords, and related identifiers for the preprint, the repository
+  and PyPI.
+
+  Zenodo reads `.zenodo.json` from the **tagged commit's tree**, and no earlier tag
+  contained it, so every archived version up to 0.6.1 carries GitHub's
+  auto-generated metadata instead. This is the first tag that fixes that.
+
+- **`scripts/add_zenodo_doi.py`** writes a Zenodo concept DOI into `README.md`,
+  `CITATION.cff` and `.zenodo.json` consistently; idempotent, with a `--check` mode.
+- **`scripts/sync_release_notes.py`** flattens Markdown tables in GitHub Release
+  bodies. Zenodo turns a release body into the archived record's description and
+  its converter does not understand tables, so a table arrives as one unreadable
+  run of pipes -- the first thing anyone following the DOI sees. `CHANGELOG.md`
+  keeps its tables, which GitHub renders correctly.
+- **`docs/RELEASING.md`** -- the release procedure, the Zenodo behaviour worth
+  knowing in advance, and when JOSS actually requires a DOI (at acceptance, not at
+  submission).
+
+### Changed
+
+- The Zenodo concept DOI [10.5281/zenodo.22830737](https://doi.org/10.5281/zenodo.22830737)
+  is recorded in the README badge and citation section, and in `CITATION.cff`.
+- `pyproject.toml` `Homepage` is now <https://fastlsq.com>; `Repository` still
+  points at GitHub, so PyPI shows both. The 0.6.1 upload predated this and shows
+  the repository as its homepage.
+- The 0.6.0 feature table's third column is headed "Benefit".
+
+### Removed
+
+- **The website.** `site/` and its GitHub Pages workflow are gone: this repository
+  is the Python package, and the site is maintained separately at
+  <https://fastlsq.com>. The old copy remains recoverable from history
+  (`git checkout 8392f6e -- site/`).
+
+## [0.6.1] - 2026-09-18
+
+A correctness and packaging pass. No published number changes, and no API is
+removed -- but three of the fixes below were silent wrong answers, not errors.
+
+### Fixed -- silent wrong answers
+
+- **kernels** -- `SeparableKernelOperator.inner_products` keyed its cache on
+  `(id(basis), n_features)`. A freed basis' address is reused by the next one, and
+  `LearnableFastLSQ.basis` builds a new basis object on every access, so a learnable fit
+  of a Fredholm problem could train on another basis' operators (measured error of the
+  assembled block 0.083 on entries of about 0.05, with no warning). The key is now the
+  storage pointer and version counter of `W` and `b`, plus a weak reference to the basis.
+- **linalg** -- `method="qr"` on a rank-deficient matrix returned garbage with no
+  exception and no warning (`||x|| = 7e18`, residual `6e4`, where `svd` gives `59` and
+  `1e-8`). The diagonal of `R` is now tested against `rcond` and warned about.
+- **learnable** -- `driver="gelsd"` was hard-coded, and torch accepts the rank-revealing
+  LAPACK drivers on CPU only, so the learnable path could not run off CPU. Now CPU-only.
+
+### Fixed -- missing operators
+
+- **augment** -- `AugmentedBasis` gained `hessian_diag`, `biharmonic`, `advection` and
+  `multi_integral`, with the closed forms for the polynomial columns.
+  `MultiIntegralOperator.apply(aug, x)` used to raise `AttributeError`, so the `Wave1D`,
+  `Wave2D_MS` and `Maxwell2D_TM` problems could not take an augmented basis at all.
+- **basis** -- a 0-d (scalar) symbol is a constant multiplier, not an error.
+- **solvers** -- `add_block(scale=...)` accepts a tuple or tensor of per-axis scales, not
+  just a list or ndarray.
+- **newton** -- when no backtracked step satisfied Armijo, the loop restored `beta` and
+  then recomputed the identical step until `max_iter`, while `history` recorded the last
+  alpha tried as if the step had been taken. It now stops, records the rejection as
+  `step_size 0.0`, and tags every exit with a stop reason.
+- **kernels** -- `from_inner_products` objects now raise a clear error from
+  `check_quadrature` and `degenerate_eigenvalues` instead of failing inside `leggauss(0)`.
+
+### Changed -- diagnostics and documentation
+
+- **linalg** -- `return_info` now carries `method_used`, because `"auto"` picks its
+  back-end at run time; on CPU with `mu = 0` it never runs QR (Cholesky probe, then
+  `gelsd`), which the module docstring claimed otherwise. The docstring now describes what
+  the code does.
+- **linalg/api** -- `rank_used` is documented as what it is: a post-hoc count of singular
+  values above `rcond * sigma_max`, not the rank the back-end worked with.
+- **newton** -- the convergence test is relative to the first residual, as the code always
+  did; the docstring said absolute.
+- **kernels** -- `degenerate_eigenvalues` no longer runs a full quadrature for inner
+  products it discards, and its docstring no longer claims the values depend on the basis.
+- **basis** -- the `1/sqrt(N)` normalisation convention is documented, including the
+  differing defaults of `solve_linear` and `solve_nonlinear`.
+
+### Tests
+
+- `test_symbol` used `np.trapz`, removed in NumPy 2, so the fractional-Laplacian check
+  against the singular-integral definition silently never ran on a current install. With
+  `np.trapezoid` the suite goes from 202 passed / 3 failed to 205 passed.
+- New `tests/test_closed_forms_property.py`: 46 property tests checking every closed form
+  against an independent reference (autograd, Gauss-Legendre quadrature, the analytic
+  characteristic value) at random dimensions, feature counts, bandwidths and orders,
+  including the cache-invalidation regression above.
+- `test_version` compared `fastlsq.__version__` against a hard-coded literal, so it had
+  to be edited on every release and never caught anything. It now compares
+  `__version__` against the version in `pyproject.toml`, which is the drift that can
+  actually happen.
+- Full suite: 251 passed.
+
+### Packaging and repository
+
+- **`scipy` is declared as a test dependency.** Eight scripts under `examples/` use it for
+  their reference solvers, and `tests/test_grad_shafranov.py` and `tests/test_grid_swing.py`
+  import those scripts -- but `scipy` appeared only in the `battery` extra, never in `dev`
+  or `requirements.txt`. `pip install -e ".[dev]"` into a clean environment produced six
+  errors; the suite passed locally only where scipy happened to be installed for other
+  reasons. Found by the new CI on its first run.
+- `fastlsq/py.typed` is now actually shipped. `[tool.setuptools.package-data]` had
+  declared it since 0.4.0, but the file did not exist, so the package advertised PEP 561
+  inline typing that type checkers never saw.
+- The build requirement is `setuptools>=77.0`. `license = "MIT"` is the PEP 639 SPDX
+  expression form, which setuptools only understands from 77.0 on; the pin said `>=68.0`.
+- Continuous integration runs the suite on Python 3.9 through 3.12 (`.github/workflows/tests.yml`).
+- The JOSS submission draft (`paper.md`, `paper.bib`) is tracked in the repository.
+- Two 0.5.x changelog entries advertised example scripts under `examples/inverse/` that
+  were never shipped; both entries now say so.
+
+### Fixed -- documentation
+
+- **The citation in `README.md` had the wrong paper title.** It read *"FastLSQ: A
+  Framework for One-Shot PDE Solving"*; the actual title of arXiv:2602.10541 is
+  *"FastLSQ: Solving PDEs in One Shot via Fourier Features with Exact Analytical
+  Derivatives"*. Anyone who copied that BibTeX block produced a wrong bibliography
+  entry. The block now matches the arXiv record and carries the DOI.
+- `paper.bib` cited the same preprint without the `FastLSQ:` title prefix. Corrected to
+  the arXiv title, so the JOSS paper and the README agree.
+
+### Added -- release tags and README
+
+- Release tags for every version, and the *Release tags* section above documenting how
+  they were reconstructed, which three are approximate, and which documented versions
+  were never released.
+- `README.md`: status badges (CI, PyPI, Python versions, licence, arXiv); the
+  dependency and optional-extras list; a **Development** section covering the test
+  suite and CI; a **Releases and versioning** section; and a pointer to the JOSS paper
+  draft.
+
+### Changed -- README
+
+- `README.md`: the BerkeleyLab ATAP talk link moved from above the project title, where
+  it preceded the description, into the **Paper** section with the other references.
+
 ## [0.6.0] - 2026-07-21
 
 Completes the operator taxonomy: multi-axis integrals, separable kernels, and
@@ -10,7 +235,7 @@ Fredholm equations, with the integral-equation problems promoted into the same
 
 ### New features
 
-| Feature | API | What it buys |
+| Feature | API | Benefit |
 |---|---|---|
 | Multi-axis integrals | `MultiIntegralOperator`, `SinusoidalBasis.multi_integral` | Integrate over any subset of axes at once, each independently definite or Volterra — area/volume functionals and mixed "definite in space, running in time" memory terms that a single-axis operator cannot express |
 | Separable (degenerate) kernels | `SeparableKernelOperator` | `K(x,y) = Σ g_m(x) h_m(y)` assembles as a rank-`R` product `G @ C`; the inner products `C` are computed once, independent of the collocation points |
@@ -361,8 +586,10 @@ augmentation columns (§2.3).
   Gauss--Hermite quadrature of the slice integral to machine precision in d = 2, 3, 4
   (≤4e-13 observed), that autodiff of the rows wrt `c` matches finite differences, and
   that a windowed field is recovered from its projections at several directions in one
-  LSQ. `examples/inverse/tomography_projection.py` demonstrates the full reconstruction
-  plus the differentiable-optics gradient.
+  LSQ. *(Correction, 0.6.1: this entry also announced an
+  `examples/inverse/tomography_projection.py` demonstrating the full reconstruction plus
+  the differentiable-optics gradient. That example was never shipped; the reconstruction
+  and the gradient check live in `tests/test_projection.py` instead.)*
 
 ### Scope (honest)
 
@@ -401,9 +628,11 @@ augmentation columns (§2.3).
   linear-least-squares design matrix; coefficients stay differentiable so learnable
   integral-term coefficients train through the solve. All three exported from `fastlsq`.
 - **Examples** `examples/integro_differential_demo.py` (one-shot forward solve of
-  `u'(x) + ∫_0^x u ds = f`, rel-L2 ~3e-11) and
-  `examples/inverse/inverse_memory_kernel.py` (recover an unknown memory strength λ from
-  noisy data via AdamW through the differentiable solve). New `tests/test_integral.py`
+  `u'(x) + ∫_0^x u ds = f`, rel-L2 ~3e-11). *(Correction, 0.6.1: this entry also
+  announced an `examples/inverse/inverse_memory_kernel.py` recovering an unknown memory
+  strength λ from noisy data via AdamW through the differentiable solve. That example was
+  never shipped; gradient flow through the solve is covered by `tests/test_integral.py`.)*
+  New `tests/test_integral.py`
   asserts ∫-then-∂ round-trips to identity, Volterra/definite match quadrature, the DC
   guard stays finite, and gradients flow to learnable coefficients.
 

fastlsq-0.6.2/CITATION.cff

@@ -0,0 +1,53 @@
+cff-version: 1.2.0
+title: "FastLSQ: One-shot PDE solving via Fourier features with exact analytical derivatives"
+message: >-
+  If you use this software, please cite the paper below. If you need to cite a
+  specific archived version of the code, use the Zenodo DOI for that version.
+type: software
+authors:
+  - family-names: Sulc
+    given-names: Antonin
+    orcid: "https://orcid.org/0000-0001-7767-778X"
+    affiliation: "Lawrence Berkeley National Laboratory, Berkeley, CA, United States"
+repository-code: "https://github.com/sulcantonin/FastLSQ"
+url: "https://fastlsq.com"
+repository-artifact: "https://pypi.org/project/FastLSQ/"
+abstract: >-
+  FastLSQ solves linear partial differential, integral and integro-differential
+  equations in a single least-squares call, by expanding the unknown in a basis of
+  random Fourier features whose derivatives and integrals are available in closed
+  form. Because every feature is a plane wave, a linear operator maps the basis to
+  another explicit matrix: no mesh, no automatic differentiation, no iterative
+  training. The closed-form derivatives make the fitted field a differentiable
+  surrogate whose operator factors once, so inverse problems and control loops can
+  afford thousands of forward solves.
+keywords:
+  - partial differential equations
+  - integral equations
+  - inverse problems
+  - Fourier features
+  - least squares
+  - closed-form derivatives
+  - differentiable surrogate
+  - scientific machine learning
+  - PyTorch
+license: MIT
+version: 0.6.2
+date-released: "2026-09-18"
+
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.22830737
+    description: Concept DOI — resolves to the latest archived version
+
+preferred-citation:
+  type: article
+  title: "FastLSQ: Solving PDEs in One Shot via Fourier Features with Exact Analytical Derivatives"
+  authors:
+    - family-names: Sulc
+      given-names: Antonin
+      orcid: "https://orcid.org/0000-0001-7767-778X"
+  year: 2026
+  doi: "10.48550/arXiv.2602.10541"
+  url: "https://arxiv.org/abs/2602.10541"
+  journal: "arXiv preprint arXiv:2602.10541"

{fastlsq-0.6.0 → fastlsq-0.6.2}/FastLSQ.egg-info/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: FastLSQ
-Version: 0.6.0
+Version: 0.6.2
 Summary: One-shot PDE solving via Fourier features with exact analytical derivatives; rank-revealing solvers, learnable anisotropic bandwidth, and CPU/CUDA/MPS support
 Author: Antonin Sulc
 License-Expression: MIT
-Project-URL: Homepage, https://github.com/sulcantonin/FastLSQ
+Project-URL: Homepage, https://fastlsq.com
 Project-URL: Repository, https://github.com/sulcantonin/FastLSQ
 Project-URL: Paper, https://arxiv.org/abs/2602.10541
 Project-URL: Bug Tracker, https://github.com/sulcantonin/FastLSQ/issues
@@ -33,6 +33,7 @@ Requires-Dist: scipy>=1.10; extra == "battery"
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: pandas>=2.0; extra == "dev"
+Requires-Dist: scipy>=1.10; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Provides-Extra: lightning
@@ -41,8 +42,13 @@ Dynamic: license-file
 
 # FastLSQ
 
-[BerkeleyLab ATAP Talk](https://github.com/sulcantonin/FastLSQ/raw/main/presentations/ATAP_Sulc_20260324.pptx)
-
+[![tests](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml/badge.svg)](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml)
+[![PyPI](https://img.shields.io/pypi/v/FastLSQ.svg)](https://pypi.org/project/FastLSQ/)
+[![Python](https://img.shields.io/pypi/pyversions/FastLSQ.svg)](https://pypi.org/project/FastLSQ/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![arXiv](https://img.shields.io/badge/arXiv-2602.10541-b31b1b.svg)](https://arxiv.org/abs/2602.10541)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22830737.svg)](https://doi.org/10.5281/zenodo.22830737)
+[![site](https://img.shields.io/badge/site-fastlsq.com-1f3df5.svg)](https://fastlsq.com)
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/sulcantonin/FastLSQ/main/misc/fastlsq_teaser.png" alt="FastLSQ method overview" width="400"/>
@@ -68,14 +74,23 @@ regularisation, 1/sqrt(N) feature normalisation, and continuation/homotopy.
 pip install fastlsq
 ```
 
-For development (includes testing and build tools):
+Requires Python 3.9+, PyTorch 2.0+, NumPy 1.24+ and Matplotlib 3.7+.  There is no
+compiled extension and no mesh library: everything runs on the PyTorch tensor stack,
+on CPU, CUDA or Apple-MPS.
+
+For development -- test runner, the SciPy reference solvers the example scripts
+compare against, and the build tools:
 
 ```bash
 git clone https://github.com/sulcantonin/FastLSQ.git
 cd FastLSQ
 pip install -e ".[dev]"
+pytest tests/          # 251 tests, about 30 s on a laptop CPU
 ```
 
+Optional extras: `.[battery]` for the battery-degradation examples (`progpy`),
+`.[lightning]` for the PyTorch Lightning training loop.
+
 ## Quick start
 
 ### Solve a linear PDE in one line
@@ -516,26 +531,62 @@ See `examples/add_your_own_pde.py` for the complete tutorial.
 - **PyTorch Lightning**: Integration for training loops
 - **20+ benchmark problems**: Linear, nonlinear, and regression-mode PDEs
 
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest tests/
+```
+
+The suite is 251 tests and runs in about 30 seconds on a laptop CPU.  Every closed
+form -- derivative, integral, Fourier symbol, projection -- is checked against an
+independent reference (autograd, Gauss-Legendre quadrature, or the analytic value) in
+`tests/test_closed_forms_property.py`, so a wrong closed form fails the suite rather
+than silently returning a plausible number.
+
+[Continuous integration](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml)
+runs the suite on Python 3.9, 3.10, 3.11 and 3.12, and separately builds the sdist and
+wheel and checks their metadata.
+
+## Releases and versioning
+
+Released versions are on [PyPI](https://pypi.org/project/FastLSQ/) and tagged in this
+repository as `vMAJOR.MINOR.PATCH`.  `CHANGELOG.md` documents every release.
+
+The tags for 0.1.0 through 0.6.0 were reconstructed after the fact, since the project
+was published to PyPI for its first year without tagging.  Each tag was matched to its
+commit by comparing the commit's `fastlsq/*.py` sources against the sdist actually
+published, so most are byte-for-byte exact; the three that are not say so in the tag
+message.  See the *Release tags* note at the top of `CHANGELOG.md`.
+
 ## Paper
 
-The full preprint is available on [arXiv](https://arxiv.org/abs/2602.10541)
+The project site, with interactive demos, is at [fastlsq.com](https://fastlsq.com). The preprint is on [arXiv](https://arxiv.org/abs/2602.10541).  A software paper for the
+[Journal of Open Source Software](https://joss.theoj.org/) is drafted in
+[`paper.md`](paper.md).
+
+There is also a [BerkeleyLab ATAP talk](https://github.com/sulcantonin/FastLSQ/raw/main/presentations/ATAP_Sulc_20260324.pptx)
+covering the method and the accelerator-physics applications.
 
 ## Citing this work
 
 If you use FastLSQ in your research, please cite:
 
 ```bibtex
-@misc{sulc2026fastlsqframeworkoneshotpde,
-      title={FastLSQ: A Framework for One-Shot PDE Solving}, 
-      author={Antonin Sulc},
-      year={2026},
-      eprint={2602.10541},
-      archivePrefix={arXiv},
-      primaryClass={math.NA},
-      url={https://arxiv.org/abs/2602.10541}, 
+@misc{sulc2026fastlsq,
+  author        = {Sulc, Antonin},
+  title         = {{FastLSQ}: Solving {PDEs} in One Shot via {Fourier} Features with Exact Analytical Derivatives},
+  year          = {2026},
+  eprint        = {2602.10541},
+  archivePrefix = {arXiv},
+  primaryClass  = {math.NA},
+  doi           = {10.48550/arXiv.2602.10541},
+  url           = {https://arxiv.org/abs/2602.10541}
 }
 ```
 
+To cite a specific archived version of the code rather than the paper, use the Zenodo concept DOI [10.5281/zenodo.22830737](https://doi.org/10.5281/zenodo.22830737), which always resolves to the most recent release.
+
 ## License
 
 This project is licensed under the MIT License -- see [LICENSE](LICENSE) for details.

{fastlsq-0.6.0 → fastlsq-0.6.2}/FastLSQ.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 CHANGELOG.md
+CITATION.cff
 LICENSE
 MANIFEST.in
 README.md
@@ -34,6 +35,7 @@ examples/run_all_extensions.py
 examples/run_linear.py
 examples/run_nonlinear.py
 examples/sdf_domains.py
+examples/stealth_navigation.py
 examples/tutorial_basic.py
 examples/tutorial_nonlinear.py
 examples/vector_basis_stream_vorticity.py
@@ -94,6 +96,7 @@ fastlsq/lightning.py
 fastlsq/linalg.py
 fastlsq/newton.py
 fastlsq/plotting.py
+fastlsq/py.typed
 fastlsq/solvers.py
 fastlsq/tuning.py
 fastlsq/utils.py
@@ -108,6 +111,7 @@ tests/test_augment.py
 tests/test_basic.py
 tests/test_benchmarks_inverse.py
 tests/test_block.py
+tests/test_closed_forms_property.py
 tests/test_derivatives.py
 tests/test_device.py
 tests/test_diagnostics_timing.py
@@ -121,5 +125,6 @@ tests/test_multi_integral.py
 tests/test_orbit_hill.py
 tests/test_problems_integral.py
 tests/test_projection.py
+tests/test_stealth_navigation.py
 tests/test_symbol.py
 tests/test_vector_basis.py

{fastlsq-0.6.0 → fastlsq-0.6.2}/FastLSQ.egg-info/requires.txt

@@ -10,6 +10,7 @@ scipy>=1.10
 [dev]
 pytest>=7.0
 pandas>=2.0
+scipy>=1.10
 build
 twine
 

{fastlsq-0.6.0 → fastlsq-0.6.2}/MANIFEST.in

@@ -1,7 +1,9 @@
 include LICENSE
 include README.md
 include CHANGELOG.md
+include CITATION.cff
 include requirements.txt
+include fastlsq/py.typed
 recursive-include examples *.py
 recursive-include tests *.py
 recursive-exclude * __pycache__

{fastlsq-0.6.0 → fastlsq-0.6.2}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: FastLSQ
-Version: 0.6.0
+Version: 0.6.2
 Summary: One-shot PDE solving via Fourier features with exact analytical derivatives; rank-revealing solvers, learnable anisotropic bandwidth, and CPU/CUDA/MPS support
 Author: Antonin Sulc
 License-Expression: MIT
-Project-URL: Homepage, https://github.com/sulcantonin/FastLSQ
+Project-URL: Homepage, https://fastlsq.com
 Project-URL: Repository, https://github.com/sulcantonin/FastLSQ
 Project-URL: Paper, https://arxiv.org/abs/2602.10541
 Project-URL: Bug Tracker, https://github.com/sulcantonin/FastLSQ/issues
@@ -33,6 +33,7 @@ Requires-Dist: scipy>=1.10; extra == "battery"
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0; extra == "dev"
 Requires-Dist: pandas>=2.0; extra == "dev"
+Requires-Dist: scipy>=1.10; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Provides-Extra: lightning
@@ -41,8 +42,13 @@ Dynamic: license-file
 
 # FastLSQ
 
-[BerkeleyLab ATAP Talk](https://github.com/sulcantonin/FastLSQ/raw/main/presentations/ATAP_Sulc_20260324.pptx)
-
+[![tests](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml/badge.svg)](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml)
+[![PyPI](https://img.shields.io/pypi/v/FastLSQ.svg)](https://pypi.org/project/FastLSQ/)
+[![Python](https://img.shields.io/pypi/pyversions/FastLSQ.svg)](https://pypi.org/project/FastLSQ/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![arXiv](https://img.shields.io/badge/arXiv-2602.10541-b31b1b.svg)](https://arxiv.org/abs/2602.10541)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22830737.svg)](https://doi.org/10.5281/zenodo.22830737)
+[![site](https://img.shields.io/badge/site-fastlsq.com-1f3df5.svg)](https://fastlsq.com)
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/sulcantonin/FastLSQ/main/misc/fastlsq_teaser.png" alt="FastLSQ method overview" width="400"/>
@@ -68,14 +74,23 @@ regularisation, 1/sqrt(N) feature normalisation, and continuation/homotopy.
 pip install fastlsq
 ```
 
-For development (includes testing and build tools):
+Requires Python 3.9+, PyTorch 2.0+, NumPy 1.24+ and Matplotlib 3.7+.  There is no
+compiled extension and no mesh library: everything runs on the PyTorch tensor stack,
+on CPU, CUDA or Apple-MPS.
+
+For development -- test runner, the SciPy reference solvers the example scripts
+compare against, and the build tools:
 
 ```bash
 git clone https://github.com/sulcantonin/FastLSQ.git
 cd FastLSQ
 pip install -e ".[dev]"
+pytest tests/          # 251 tests, about 30 s on a laptop CPU
 ```
 
+Optional extras: `.[battery]` for the battery-degradation examples (`progpy`),
+`.[lightning]` for the PyTorch Lightning training loop.
+
 ## Quick start
 
 ### Solve a linear PDE in one line
@@ -516,26 +531,62 @@ See `examples/add_your_own_pde.py` for the complete tutorial.
 - **PyTorch Lightning**: Integration for training loops
 - **20+ benchmark problems**: Linear, nonlinear, and regression-mode PDEs
 
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest tests/
+```
+
+The suite is 251 tests and runs in about 30 seconds on a laptop CPU.  Every closed
+form -- derivative, integral, Fourier symbol, projection -- is checked against an
+independent reference (autograd, Gauss-Legendre quadrature, or the analytic value) in
+`tests/test_closed_forms_property.py`, so a wrong closed form fails the suite rather
+than silently returning a plausible number.
+
+[Continuous integration](https://github.com/sulcantonin/FastLSQ/actions/workflows/tests.yml)
+runs the suite on Python 3.9, 3.10, 3.11 and 3.12, and separately builds the sdist and
+wheel and checks their metadata.
+
+## Releases and versioning
+
+Released versions are on [PyPI](https://pypi.org/project/FastLSQ/) and tagged in this
+repository as `vMAJOR.MINOR.PATCH`.  `CHANGELOG.md` documents every release.
+
+The tags for 0.1.0 through 0.6.0 were reconstructed after the fact, since the project
+was published to PyPI for its first year without tagging.  Each tag was matched to its
+commit by comparing the commit's `fastlsq/*.py` sources against the sdist actually
+published, so most are byte-for-byte exact; the three that are not say so in the tag
+message.  See the *Release tags* note at the top of `CHANGELOG.md`.
+
 ## Paper
 
-The full preprint is available on [arXiv](https://arxiv.org/abs/2602.10541)
+The project site, with interactive demos, is at [fastlsq.com](https://fastlsq.com). The preprint is on [arXiv](https://arxiv.org/abs/2602.10541).  A software paper for the
+[Journal of Open Source Software](https://joss.theoj.org/) is drafted in
+[`paper.md`](paper.md).
+
+There is also a [BerkeleyLab ATAP talk](https://github.com/sulcantonin/FastLSQ/raw/main/presentations/ATAP_Sulc_20260324.pptx)
+covering the method and the accelerator-physics applications.
 
 ## Citing this work
 
 If you use FastLSQ in your research, please cite:
 
 ```bibtex
-@misc{sulc2026fastlsqframeworkoneshotpde,
-      title={FastLSQ: A Framework for One-Shot PDE Solving}, 
-      author={Antonin Sulc},
-      year={2026},
-      eprint={2602.10541},
-      archivePrefix={arXiv},
-      primaryClass={math.NA},
-      url={https://arxiv.org/abs/2602.10541}, 
+@misc{sulc2026fastlsq,
+  author        = {Sulc, Antonin},
+  title         = {{FastLSQ}: Solving {PDEs} in One Shot via {Fourier} Features with Exact Analytical Derivatives},
+  year          = {2026},
+  eprint        = {2602.10541},
+  archivePrefix = {arXiv},
+  primaryClass  = {math.NA},
+  doi           = {10.48550/arXiv.2602.10541},
+  url           = {https://arxiv.org/abs/2602.10541}
 }
 ```
 
+To cite a specific archived version of the code rather than the paper, use the Zenodo concept DOI [10.5281/zenodo.22830737](https://doi.org/10.5281/zenodo.22830737), which always resolves to the most recent release.
+
 ## License
 
 This project is licensed under the MIT License -- see [LICENSE](LICENSE) for details.