cryosweep 0.3.0__tar.gz

cryosweep-0.3.0/LICENSE

@@ -0,0 +1,79 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.
+
+---
+
+Required Notice: Copyright 2026 Volodymyr Buturlim (https://orcid.org/0000-0001-8851-2489)
+
+Commercial use is not granted by this licence. See COMMERCIAL.md.

cryosweep-0.3.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: cryosweep
+Version: 0.3.0
+Summary: Agent-drivable analysis of Quantum Design PPMS/MPMS measurement files: VSM, AC susceptibility, thermal transport, resistivity, heat capacity and Hall.
+Author: Volodymyr Buturlim
+License-Expression: PolyForm-Noncommercial-1.0.0
+Project-URL: Homepage, https://github.com/Vova2B/cryosweep
+Project-URL: Source, https://github.com/Vova2B/cryosweep
+Project-URL: Issues, https://github.com/Vova2B/cryosweep/issues
+Project-URL: Changelog, https://github.com/Vova2B/cryosweep/blob/main/CHANGELOG.md
+Project-URL: Physics reference, https://github.com/Vova2B/cryosweep/blob/main/docs/physics-reference.md
+Keywords: condensed-matter,physics,PPMS,MPMS,magnetometry,transport,thermal-transport
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD-PARTY-LICENSES.md
+Requires-Dist: numpy>=2.0
+Requires-Dist: pandas>=2.2
+Requires-Dist: scipy>=1.13
+Requires-Dist: pydantic>=2.6
+Requires-Dist: matplotlib>=3.11
+Provides-Extra: gui
+Requires-Dist: PySide6-Essentials>=6.7; extra == "gui"
+Dynamic: license-file
+
+# cryosweep
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22307209.svg)](https://doi.org/10.5281/zenodo.22307209)
+
+Analysis of Quantum Design **PPMS** and **MPMS** measurement files (`.dat`) — a Qt-free
+analysis core with a JSON contract, a command-line interface, and a desktop GUI built on the
+same analyzers.
+
+One file in, physics out: cryosweep detects which measurement it is looking at, separates the
+sweeps, fits the appropriate models, and reports what it found — including when it *cannot*
+report something, and why.
+
+![The cryosweep heat-capacity tab: low-temperature Cp/T models, full-range Debye-Einstein fit, entropy S(T), and per-field gamma and Debye temperature](https://raw.githubusercontent.com/Vova2B/cryosweep/main/docs/images/heat-capacity-multifield.png)
+
+*That last clause is the point. In the status bar above, cryosweep reports θ_D drifting 160 %
+across fields — the lattice should be field-independent — and a Sommerfeld coefficient γ that has
+gone negative. Neither is handed back as a result; both are flagged as physics that does not hold.*
+
+| Probe | What it fits |
+|---|---|
+| **Magnetization (VSM)** — QD + MPMS formats | χ, 1/χ, Curie-Weiss (θ, C, μ_eff) with a window-sensitivity ladder |
+| **AC susceptibility (ACMS)** | χ′/χ″, superconducting screening step, T_c, χ″ peak / freezing temperature |
+| **Thermal transport (TTO)** | κ, Seebeck, ZT, Wiedemann-Franz decomposition, Lorenz ratio, κ_ph power law |
+| **Resistivity** — QD Resistivity + AC Transport | ρ(T), RRR ± σ, magnetoresistance, resistive T_c, power-law / Fermi-liquid fit |
+| **Heat capacity** | Debye-Einstein Cp(T), low-T Cp/T vs T², spin-fluctuation models, entropy S(T), Schottky |
+| **Hall effect** | Antisymmetrized R_xy, R_H, carrier density, mobility, R_H(T) |
+
+The physics behind each — the models, the fitted quantities, and the criteria the detectors
+use — is documented in [`docs/physics-reference.md`](https://github.com/Vova2B/cryosweep/blob/main/docs/physics-reference.md).
+
+## Install
+
+```bash
+pip install cryosweep          # core + command line
+pip install 'cryosweep[gui]'   # adds the desktop app
+```
+
+The GUI is optional because the analysis core and CLI are Qt-free by design, and Qt is by far
+the heaviest dependency here — leaving it out keeps an agent or CI install a quarter of the size.
+Installing without it still gives you every analyzer; only `cryosweep-gui` needs the extra, and it
+says so if you run it.
+
+From a clone, for development:
+
+```bash
+python3 -m venv .venv
+.venv/bin/pip install -e '.[gui]'
+```
+
+Python ≥ 3.11 (developed and tested on 3.14).
+
+## Quickstart
+
+The [`examples/`](https://github.com/Vova2B/cryosweep/tree/main/examples) folder has a runnable file per probe, so you can try
+everything before pointing it at your own data ([`examples/README.md`](https://github.com/Vova2B/cryosweep/blob/main/examples/README.md)
+says what each file shows and which tab/inputs to use — the Hall examples in particular
+open on the Resistivity tab first, because Hall measurements share the resistivity file
+format).
+
+Those files ship with the repository rather than the wheel, so after a `pip install` fetch one
+first — or clone the repo and run the commands as written:
+
+```bash
+curl -O https://raw.githubusercontent.com/Vova2B/cryosweep/main/examples/heat_capacity.dat
+cryosweep analyze heat_capacity.dat
+```
+
+```bash
+cryosweep analyze examples/magnetization_vsm.dat        # Curie-Weiss: theta = -10 K
+cryosweep analyze examples/heat_capacity.dat
+cryosweep analyze examples/thermal_transport.dat
+cryosweep report  examples/resistivity_superconductor.dat   # Markdown summary
+cryosweep-gui                                           # the desktop app
+```
+
+Some measurements need inputs the file does not carry. MPMS files hold no molar mass or sample
+mass, so the analyzer **gates** rather than guessing — supply them and it proceeds:
+
+```bash
+cryosweep analyze examples/magnetization_mpms.dat --molar-mass 200 --mass-mg 5
+```
+
+Hall measurements use the same file format as ordinary resistivity — only the wiring differs —
+so the Hall analyzer is invoked explicitly, with the channel and the sample thickness:
+
+```bash
+cryosweep hall examples/hall_field_sweeps.dat \
+    --hall-channel 1 --thickness 0.5 --thickness-unit mm --long-channel 2
+# R_H = -2.500e-07 m^3/C
+```
+
+## Built to be driven by a program
+
+Every command prints **one JSON object** on stdout (logs go to stderr) and sets a meaningful
+exit code, so cryosweep is usable from a script, a pipeline, or an LLM agent without screen
+scraping:
+
+```bash
+cryosweep probes                     # available measurement types and what each one needs
+cryosweep schema analyze:vsm         # JSON Schema for the result shape
+cryosweep export <file> --out result # tidy long-format CSVs, units in the headers
+cryosweep run pipeline.json          # batch
+```
+
+Exit codes distinguish *no result* from *a result you should look at*: `0` ok, `10` gated (a
+required input is missing — the payload names the flag), `11` low confidence, `2` bad input.
+Codes 10 and 11 still print a full JSON envelope. Output is byte-stable for the same input, so
+it diffs and caches cleanly. A ready-made agent guide ships in
+[`skill/cryosweep/SKILL.md`](https://github.com/Vova2B/cryosweep/blob/main/skill/cryosweep/SKILL.md).
+
+## Example data
+
+Everything in `examples/` is written by `tools/make_examples.py`.
+
+**Eight of the ten files are synthetic**, generated by the same builders that produce the test
+fixtures. The numbers are physically consistent and each file places a feature where it
+exercises the relevant analyzer — but they are **not measurements of any real material**.
+
+**Two are anonymized subsets of real measurements** — `magnetization_vsm_multifield.dat` and
+`heat_capacity_multifield.dat` — because no synthetic file reproduces what real multi-field
+data does to the segmentation and window-selection paths. They are decimated, and everything
+that identified the sample, the operator or the instrument has been replaced: sample material
+and comment, all five instrument serial numbers, the acquisition date (the absolute
+`Time Stamp` column is rebased to zero, since it decodes to the measurement instant), the
+calibration free text in the `Comment` column, and the formula weight and sample mass, which
+are neutral values chosen only so the fits report a plausible moment. The generators carry an
+`assert_no_identity_leak` post-condition that refuses to write the file if any token of the
+source identity survives. The measured *shapes* are real; the sample metadata is not, and **no
+scientific conclusion should be drawn from any file here**.
+
+Regenerate with (the two real-derived files are skipped, and left untouched, on any machine
+without the private source data):
+
+```bash
+python tools/make_examples.py
+```
+
+## Tests
+
+```bash
+QT_QPA_PLATFORM=offscreen python -m pytest
+```
+
+Run it from the repository root — some tests build fixture paths relative to the working
+directory and launch the CLI as a subprocess.
+
+The suite ships with synthetic `.dat` fixtures only. Tests that need real measurement files, or
+the maintainer's local reference gallery, **skip** when those are absent, so a fresh clone is
+green with no data at all. To exercise the optional real-data tests against your own files,
+create `real_data_map.json` in the repository root mapping logical keys to paths.
+
+## File format and provenance
+
+The `.dat` files this program reads are produced by Quantum Design instrument software and
+retain their original `; Copyright …, Quantum Design, Inc.` header lines; those are part of the
+format and are preserved rather than stripped. The format is **read**, not redistributed.
+
+This project is not affiliated with, endorsed by, or supported by Quantum Design, Inc. "PPMS"
+and "MPMS" are used only to identify the instruments and file formats cryosweep is compatible
+with. PPMS is a registered trademark of Quantum Design, Inc.
+
+## Licence
+
+cryosweep is released under the [PolyForm Noncommercial License 1.0.0](https://github.com/Vova2B/cryosweep/blob/main/LICENSE).
+
+**Free for research and education** — universities, public research institutes, national
+laboratories, government and nonprofit organizations, and individuals, *regardless of how the
+work is funded*. Use it, modify it, redistribute it, publish results with it.
+
+**Commercial use requires a licence.** If you are a company, see
+[COMMERCIAL.md](https://github.com/Vova2B/cryosweep/blob/main/COMMERCIAL.md) — it is a short email to `info@cryosweep.org`.
+
+Third-party dependency licences, and what the LGPL requires of the Qt binding, are recorded in
+[THIRD-PARTY-LICENSES.md](https://github.com/Vova2B/cryosweep/blob/main/THIRD-PARTY-LICENSES.md).
+
+## Known issues
+
+Known defects are listed in [KNOWN-ISSUES.md](https://github.com/Vova2B/cryosweep/blob/main/KNOWN-ISSUES.md). Most are display or
+ergonomics issues found by inspecting every rendered example, and each of those names the
+example file that reproduces it; none of them changes a fitted number or an exported value.
+Two exceptions are called out explicitly there — a temperature-setpoint binning bug in the
+Hall analyzer that can fabricate a carrier-density point, and the derived-quantity fallback
+that lets it reach the CSV. Both were found on real data and reproduce on no shipped example.
+
+## Versioning
+
+Semantic versioning. While the version is **0.x** the interfaces are not frozen: the CLI JSON
+envelope, the exit codes and the CSV columns may change between releases. Tagging **1.0.0** is
+what freezes them.
+
+Plot appearance, GUI layout and the internal Python API are not covered by that promise at any
+version — figures are expected to improve, and doing so is not a breaking change.
+
+## Project documents
+
+- [CHANGELOG.md](https://github.com/Vova2B/cryosweep/blob/main/CHANGELOG.md) — what is in each release
+- [ROADMAP.md](https://github.com/Vova2B/cryosweep/blob/main/ROADMAP.md) — what is planned for 1.0, with measured costs where they were measured
+- [KNOWN-ISSUES.md](https://github.com/Vova2B/cryosweep/blob/main/KNOWN-ISSUES.md) — known defects found and deferred, with what reproduces each
+- [CONTRIBUTING.md](https://github.com/Vova2B/cryosweep/blob/main/CONTRIBUTING.md) and [CLA.md](https://github.com/Vova2B/cryosweep/blob/main/CLA.md) — how to contribute, and the one-time agreement
+- [SECURITY.md](https://github.com/Vova2B/cryosweep/blob/main/SECURITY.md) — reporting a vulnerability
+- [CODE_OF_CONDUCT.md](https://github.com/Vova2B/cryosweep/blob/main/CODE_OF_CONDUCT.md)
+
+## Contributing
+
+Bug reports, files that break the loader, and pull requests are welcome — see
+[CONTRIBUTING.md](https://github.com/Vova2B/cryosweep/blob/main/CONTRIBUTING.md). Because the project is dual-licensed, a pull request needs a
+one-time [Contributor License Agreement](https://github.com/Vova2B/cryosweep/blob/main/CLA.md); you keep your copyright, and a bot walks you
+through it on your first PR.
+
+## Citing
+
+If cryosweep contributes to work you publish, please cite it — see
+[CITATION.cff](https://github.com/Vova2B/cryosweep/blob/main/CITATION.cff).

cryosweep-0.3.0/README.md

@@ -0,0 +1,213 @@
+# cryosweep
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.22307209.svg)](https://doi.org/10.5281/zenodo.22307209)
+
+Analysis of Quantum Design **PPMS** and **MPMS** measurement files (`.dat`) — a Qt-free
+analysis core with a JSON contract, a command-line interface, and a desktop GUI built on the
+same analyzers.
+
+One file in, physics out: cryosweep detects which measurement it is looking at, separates the
+sweeps, fits the appropriate models, and reports what it found — including when it *cannot*
+report something, and why.
+
+![The cryosweep heat-capacity tab: low-temperature Cp/T models, full-range Debye-Einstein fit, entropy S(T), and per-field gamma and Debye temperature](https://raw.githubusercontent.com/Vova2B/cryosweep/main/docs/images/heat-capacity-multifield.png)
+
+*That last clause is the point. In the status bar above, cryosweep reports θ_D drifting 160 %
+across fields — the lattice should be field-independent — and a Sommerfeld coefficient γ that has
+gone negative. Neither is handed back as a result; both are flagged as physics that does not hold.*
+
+| Probe | What it fits |
+|---|---|
+| **Magnetization (VSM)** — QD + MPMS formats | χ, 1/χ, Curie-Weiss (θ, C, μ_eff) with a window-sensitivity ladder |
+| **AC susceptibility (ACMS)** | χ′/χ″, superconducting screening step, T_c, χ″ peak / freezing temperature |
+| **Thermal transport (TTO)** | κ, Seebeck, ZT, Wiedemann-Franz decomposition, Lorenz ratio, κ_ph power law |
+| **Resistivity** — QD Resistivity + AC Transport | ρ(T), RRR ± σ, magnetoresistance, resistive T_c, power-law / Fermi-liquid fit |
+| **Heat capacity** | Debye-Einstein Cp(T), low-T Cp/T vs T², spin-fluctuation models, entropy S(T), Schottky |
+| **Hall effect** | Antisymmetrized R_xy, R_H, carrier density, mobility, R_H(T) |
+
+The physics behind each — the models, the fitted quantities, and the criteria the detectors
+use — is documented in [`docs/physics-reference.md`](https://github.com/Vova2B/cryosweep/blob/main/docs/physics-reference.md).
+
+## Install
+
+```bash
+pip install cryosweep          # core + command line
+pip install 'cryosweep[gui]'   # adds the desktop app
+```
+
+The GUI is optional because the analysis core and CLI are Qt-free by design, and Qt is by far
+the heaviest dependency here — leaving it out keeps an agent or CI install a quarter of the size.
+Installing without it still gives you every analyzer; only `cryosweep-gui` needs the extra, and it
+says so if you run it.
+
+From a clone, for development:
+
+```bash
+python3 -m venv .venv
+.venv/bin/pip install -e '.[gui]'
+```
+
+Python ≥ 3.11 (developed and tested on 3.14).
+
+## Quickstart
+
+The [`examples/`](https://github.com/Vova2B/cryosweep/tree/main/examples) folder has a runnable file per probe, so you can try
+everything before pointing it at your own data ([`examples/README.md`](https://github.com/Vova2B/cryosweep/blob/main/examples/README.md)
+says what each file shows and which tab/inputs to use — the Hall examples in particular
+open on the Resistivity tab first, because Hall measurements share the resistivity file
+format).
+
+Those files ship with the repository rather than the wheel, so after a `pip install` fetch one
+first — or clone the repo and run the commands as written:
+
+```bash
+curl -O https://raw.githubusercontent.com/Vova2B/cryosweep/main/examples/heat_capacity.dat
+cryosweep analyze heat_capacity.dat
+```
+
+```bash
+cryosweep analyze examples/magnetization_vsm.dat        # Curie-Weiss: theta = -10 K
+cryosweep analyze examples/heat_capacity.dat
+cryosweep analyze examples/thermal_transport.dat
+cryosweep report  examples/resistivity_superconductor.dat   # Markdown summary
+cryosweep-gui                                           # the desktop app
+```
+
+Some measurements need inputs the file does not carry. MPMS files hold no molar mass or sample
+mass, so the analyzer **gates** rather than guessing — supply them and it proceeds:
+
+```bash
+cryosweep analyze examples/magnetization_mpms.dat --molar-mass 200 --mass-mg 5
+```
+
+Hall measurements use the same file format as ordinary resistivity — only the wiring differs —
+so the Hall analyzer is invoked explicitly, with the channel and the sample thickness:
+
+```bash
+cryosweep hall examples/hall_field_sweeps.dat \
+    --hall-channel 1 --thickness 0.5 --thickness-unit mm --long-channel 2
+# R_H = -2.500e-07 m^3/C
+```
+
+## Built to be driven by a program
+
+Every command prints **one JSON object** on stdout (logs go to stderr) and sets a meaningful
+exit code, so cryosweep is usable from a script, a pipeline, or an LLM agent without screen
+scraping:
+
+```bash
+cryosweep probes                     # available measurement types and what each one needs
+cryosweep schema analyze:vsm         # JSON Schema for the result shape
+cryosweep export <file> --out result # tidy long-format CSVs, units in the headers
+cryosweep run pipeline.json          # batch
+```
+
+Exit codes distinguish *no result* from *a result you should look at*: `0` ok, `10` gated (a
+required input is missing — the payload names the flag), `11` low confidence, `2` bad input.
+Codes 10 and 11 still print a full JSON envelope. Output is byte-stable for the same input, so
+it diffs and caches cleanly. A ready-made agent guide ships in
+[`skill/cryosweep/SKILL.md`](https://github.com/Vova2B/cryosweep/blob/main/skill/cryosweep/SKILL.md).
+
+## Example data
+
+Everything in `examples/` is written by `tools/make_examples.py`.
+
+**Eight of the ten files are synthetic**, generated by the same builders that produce the test
+fixtures. The numbers are physically consistent and each file places a feature where it
+exercises the relevant analyzer — but they are **not measurements of any real material**.
+
+**Two are anonymized subsets of real measurements** — `magnetization_vsm_multifield.dat` and
+`heat_capacity_multifield.dat` — because no synthetic file reproduces what real multi-field
+data does to the segmentation and window-selection paths. They are decimated, and everything
+that identified the sample, the operator or the instrument has been replaced: sample material
+and comment, all five instrument serial numbers, the acquisition date (the absolute
+`Time Stamp` column is rebased to zero, since it decodes to the measurement instant), the
+calibration free text in the `Comment` column, and the formula weight and sample mass, which
+are neutral values chosen only so the fits report a plausible moment. The generators carry an
+`assert_no_identity_leak` post-condition that refuses to write the file if any token of the
+source identity survives. The measured *shapes* are real; the sample metadata is not, and **no
+scientific conclusion should be drawn from any file here**.
+
+Regenerate with (the two real-derived files are skipped, and left untouched, on any machine
+without the private source data):
+
+```bash
+python tools/make_examples.py
+```
+
+## Tests
+
+```bash
+QT_QPA_PLATFORM=offscreen python -m pytest
+```
+
+Run it from the repository root — some tests build fixture paths relative to the working
+directory and launch the CLI as a subprocess.
+
+The suite ships with synthetic `.dat` fixtures only. Tests that need real measurement files, or
+the maintainer's local reference gallery, **skip** when those are absent, so a fresh clone is
+green with no data at all. To exercise the optional real-data tests against your own files,
+create `real_data_map.json` in the repository root mapping logical keys to paths.
+
+## File format and provenance
+
+The `.dat` files this program reads are produced by Quantum Design instrument software and
+retain their original `; Copyright …, Quantum Design, Inc.` header lines; those are part of the
+format and are preserved rather than stripped. The format is **read**, not redistributed.
+
+This project is not affiliated with, endorsed by, or supported by Quantum Design, Inc. "PPMS"
+and "MPMS" are used only to identify the instruments and file formats cryosweep is compatible
+with. PPMS is a registered trademark of Quantum Design, Inc.
+
+## Licence
+
+cryosweep is released under the [PolyForm Noncommercial License 1.0.0](https://github.com/Vova2B/cryosweep/blob/main/LICENSE).
+
+**Free for research and education** — universities, public research institutes, national
+laboratories, government and nonprofit organizations, and individuals, *regardless of how the
+work is funded*. Use it, modify it, redistribute it, publish results with it.
+
+**Commercial use requires a licence.** If you are a company, see
+[COMMERCIAL.md](https://github.com/Vova2B/cryosweep/blob/main/COMMERCIAL.md) — it is a short email to `info@cryosweep.org`.
+
+Third-party dependency licences, and what the LGPL requires of the Qt binding, are recorded in
+[THIRD-PARTY-LICENSES.md](https://github.com/Vova2B/cryosweep/blob/main/THIRD-PARTY-LICENSES.md).
+
+## Known issues
+
+Known defects are listed in [KNOWN-ISSUES.md](https://github.com/Vova2B/cryosweep/blob/main/KNOWN-ISSUES.md). Most are display or
+ergonomics issues found by inspecting every rendered example, and each of those names the
+example file that reproduces it; none of them changes a fitted number or an exported value.
+Two exceptions are called out explicitly there — a temperature-setpoint binning bug in the
+Hall analyzer that can fabricate a carrier-density point, and the derived-quantity fallback
+that lets it reach the CSV. Both were found on real data and reproduce on no shipped example.
+
+## Versioning
+
+Semantic versioning. While the version is **0.x** the interfaces are not frozen: the CLI JSON
+envelope, the exit codes and the CSV columns may change between releases. Tagging **1.0.0** is
+what freezes them.
+
+Plot appearance, GUI layout and the internal Python API are not covered by that promise at any
+version — figures are expected to improve, and doing so is not a breaking change.
+
+## Project documents
+
+- [CHANGELOG.md](https://github.com/Vova2B/cryosweep/blob/main/CHANGELOG.md) — what is in each release
+- [ROADMAP.md](https://github.com/Vova2B/cryosweep/blob/main/ROADMAP.md) — what is planned for 1.0, with measured costs where they were measured
+- [KNOWN-ISSUES.md](https://github.com/Vova2B/cryosweep/blob/main/KNOWN-ISSUES.md) — known defects found and deferred, with what reproduces each
+- [CONTRIBUTING.md](https://github.com/Vova2B/cryosweep/blob/main/CONTRIBUTING.md) and [CLA.md](https://github.com/Vova2B/cryosweep/blob/main/CLA.md) — how to contribute, and the one-time agreement
+- [SECURITY.md](https://github.com/Vova2B/cryosweep/blob/main/SECURITY.md) — reporting a vulnerability
+- [CODE_OF_CONDUCT.md](https://github.com/Vova2B/cryosweep/blob/main/CODE_OF_CONDUCT.md)
+
+## Contributing
+
+Bug reports, files that break the loader, and pull requests are welcome — see
+[CONTRIBUTING.md](https://github.com/Vova2B/cryosweep/blob/main/CONTRIBUTING.md). Because the project is dual-licensed, a pull request needs a
+one-time [Contributor License Agreement](https://github.com/Vova2B/cryosweep/blob/main/CLA.md); you keep your copyright, and a bot walks you
+through it on your first PR.
+
+## Citing
+
+If cryosweep contributes to work you publish, please cite it — see
+[CITATION.cff](https://github.com/Vova2B/cryosweep/blob/main/CITATION.cff).

cryosweep-0.3.0/THIRD-PARTY-LICENSES.md

@@ -0,0 +1,66 @@
+# Third-party licences
+
+cryosweep itself is licensed under the [PolyForm Noncommercial License 1.0.0](LICENSE).
+It does **not** bundle or redistribute any of the packages below — they are declared as
+dependencies in `pyproject.toml` and installed by pip from PyPI, each under its own
+licence. This file records what those licences are and what they require.
+
+| Package | Licence | Notes |
+|---|---|---|
+| [numpy](https://numpy.org) | BSD-3-Clause (with vendored 0BSD / MIT / Zlib components) | Permissive |
+| [pandas](https://pandas.pydata.org) | BSD-3-Clause | Permissive |
+| [scipy](https://scipy.org) | BSD-3-Clause | Permissive |
+| [pydantic](https://docs.pydantic.dev) | MIT | Permissive |
+| [matplotlib](https://matplotlib.org) | Matplotlib licence (PSF-based, BSD-compatible) | Permissive |
+| [PySide6 / Qt for Python](https://doc.qt.io/qtforpython/) | **LGPL-3.0-only** (also available under GPL-2.0 / GPL-3.0, or a commercial Qt licence) | See below |
+
+All of these are compatible with distributing cryosweep under a noncommercial
+source-available licence. None of them imposes copyleft on cryosweep's own source.
+
+## PySide6 and the LGPL — why this matters
+
+The GUI uses **PySide6 (Qt for Python)** under the **LGPL-3.0**. This choice is
+deliberate and load-bearing: the alternative Python binding, PyQt6, is offered only
+under the GPL or a paid commercial licence, and the GPL option would force cryosweep's
+own source to be GPL — which is incompatible with the licensing model here.
+
+The LGPL permits combining a work under a licence of your choosing with the library,
+provided the recipient can replace the LGPL-licensed library with their own version.
+cryosweep satisfies this by construction:
+
+- it is distributed **as source**, and PySide6 is installed separately by pip;
+- nothing is statically linked, and no Qt libraries are bundled or modified;
+- any user can upgrade, patch, or substitute their own PySide6 build at any time.
+
+The analysis core (`cryosweep_core`) imports no Qt at all — a property enforced by a
+test (`tests/core/test_qt_free.py`) — so the CLI and the library are usable with no Qt
+present on the system.
+
+**If cryosweep is ever redistributed as a frozen binary** (PyInstaller, Nuitka, an app
+bundle, or any single-file executable), the LGPL relinking obligation stops being
+satisfied automatically and must be addressed explicitly: ship the Qt libraries as
+separate shared objects the user can replace, include the LGPL text and the required
+notices, and offer the corresponding source for the Qt components. Do not freeze a
+release without handling this.
+
+## Obtaining the licence texts
+
+Each package ships its own licence in its distribution:
+
+```bash
+pip show -f <package>          # locate the installed package
+python -c "import importlib.metadata as m; print(m.metadata('<package>')['License'])"
+```
+
+Canonical texts: [BSD-3-Clause](https://opensource.org/license/bsd-3-clause),
+[MIT](https://opensource.org/license/mit),
+[LGPL-3.0](https://www.gnu.org/licenses/lgpl-3.0.html),
+[matplotlib](https://matplotlib.org/stable/project/license.html).
+
+## Not a dependency: Quantum Design
+
+cryosweep reads the `.dat` files produced by Quantum Design PPMS and MPMS instruments.
+It contains no Quantum Design code and is not affiliated with, endorsed by, or a
+product of Quantum Design, Inc. "PPMS" and "MPMS" are used only to describe the file
+formats and instruments the software is compatible with. PPMS is a registered
+trademark of Quantum Design, Inc.