midas-suite 0.2.0__py3-none-any.whl

midas_suite/__init__.py

@@ -0,0 +1,64 @@
+"""midas-suite: meta-package that installs the MIDAS Python pipeline.
+
+This package contains no scientific code of its own. It declares the
+MIDAS sub-packages as dependencies so that ``pip install midas-suite``
+gives a user the full pipeline in one step.
+
+The actual modules live in their own packages and are imported under
+their own names (``midas_stress``, ``midas_diffract``, ``midas_index``,
+etc.) — this package does not re-export them.
+
+To inspect what was installed:
+
+    >>> import midas_suite
+    >>> print(midas_suite.installed())
+
+"""
+
+__version__ = "0.2.0"
+
+# The sub-packages this meta-package pulls in (in publish-order).
+# Kept in sync with pyproject.toml's ``dependencies`` list.
+SUBPACKAGES = (
+    # leaves
+    "midas_stress",
+    "midas_params",
+    "midas_hkls",
+    "midas_diffract",
+    "midas_peakfit",
+    "midas_integrate",
+    "midas_calibrate",
+    "midas_index",
+    "midas_transforms",
+    "midas_process_grains",
+    "midas_fit_grain",
+    "midas_nf_preprocess",
+    "midas_nf_fitorientation",
+    # parsl + pipeline orchestrators
+    "midas_parsl_configs",
+    "midas_ff_pipeline",
+    "midas_nf_pipeline",
+)
+
+
+def installed():
+    """Return a dict {sub_package_name: version_or_None} for every
+    MIDAS sub-package this meta-package declares as a dependency.
+
+    Useful for ``midas_suite.installed()`` from a notebook or REPL to
+    confirm what got pulled in by ``pip install midas-suite``.
+    """
+    import importlib
+
+    out = {}
+    for name in SUBPACKAGES:
+        try:
+            mod = importlib.import_module(name)
+        except ImportError:
+            out[name] = None
+            continue
+        out[name] = getattr(mod, "__version__", "unknown")
+    return out
+
+
+__all__ = ["__version__", "SUBPACKAGES", "installed"]

midas_suite-0.2.0.dist-info/METADATA

@@ -0,0 +1,194 @@
+Metadata-Version: 2.4
+Name: midas-suite
+Version: 0.2.0
+Summary: Meta-package: installs the MIDAS Python pipeline (FF/NF/PF HEDM, calibration, peakfit, integration, transforms, ODF, stress).
+Author-email: Hemant Sharma <hsharma@anl.gov>
+License: BSD-3-Clause
+Project-URL: Homepage, https://github.com/marinerhemant/MIDAS
+Project-URL: Issues, https://github.com/marinerhemant/MIDAS/issues
+Keywords: MIDAS,HEDM,3DXRD,powder diffraction,tomography,DCT,Laue,synchrotron,crystallography,PyTorch
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: midas-stress>=0.6.0
+Requires-Dist: midas-params>=0.3.0
+Requires-Dist: midas-hkls>=0.3.0
+Requires-Dist: midas-diffract>=0.1.0
+Requires-Dist: midas-peakfit>=0.3.0
+Requires-Dist: midas-integrate>=0.3.2
+Requires-Dist: midas-calibrate>=0.2.1
+Requires-Dist: midas-index>=0.3.0
+Requires-Dist: midas-transforms>=0.2.0
+Requires-Dist: midas-process-grains>=0.1.0
+Requires-Dist: midas-fit-grain>=0.1.0
+Requires-Dist: midas-nf-preprocess>=0.1.0
+Requires-Dist: midas-nf-fitorientation>=0.3.0
+Requires-Dist: midas-parsl-configs>=0.1.0
+Requires-Dist: midas-ff-pipeline>=0.1.0
+Requires-Dist: midas-nf-pipeline>=0.1.0
+Provides-Extra: ff
+Requires-Dist: midas-stress>=0.6.0; extra == "ff"
+Requires-Dist: midas-params>=0.3.0; extra == "ff"
+Requires-Dist: midas-ff-pipeline>=0.1.0; extra == "ff"
+Requires-Dist: midas-calibrate>=0.2.1; extra == "ff"
+Requires-Dist: midas-integrate>=0.3.2; extra == "ff"
+Provides-Extra: nf
+Requires-Dist: midas-stress>=0.6.0; extra == "nf"
+Requires-Dist: midas-params>=0.3.0; extra == "nf"
+Requires-Dist: midas-nf-pipeline>=0.1.0; extra == "nf"
+Provides-Extra: calib
+Requires-Dist: midas-hkls>=0.3.0; extra == "calib"
+Requires-Dist: midas-integrate>=0.3.2; extra == "calib"
+Requires-Dist: midas-peakfit>=0.3.0; extra == "calib"
+Requires-Dist: midas-calibrate>=0.2.1; extra == "calib"
+Provides-Extra: plots
+Requires-Dist: matplotlib>=3.5; extra == "plots"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+
+# midas-suite
+
+A meta-package that installs the MIDAS Python pipeline in a single command.
+
+```bash
+pip install midas-suite
+```
+
+This pulls in the currently published MIDAS sub-packages — the FF/NF
+HEDM analysis chain, calibration, peak fitting, radial integration,
+forward model, indexing, transforms, grain processing, and stress/strain
+analysis.
+
+`midas-suite` itself contains no scientific code. It's a thin
+[meta-package](https://packaging.python.org/en/latest/glossary/#term-Distribution-Package)
+whose only job is to declare the sub-packages as dependencies so users
+don't have to install them one at a time.
+
+## What you get
+
+`pip install midas-suite` installs **16 sub-packages** (as of v0.1.0):
+
+**Top-level orchestrators (the entry points most users want):**
+
+| Sub-package | Role |
+|---|---|
+| `midas-ff-pipeline` | End-to-end pure-Python FF-HEDM workflow orchestrator (1-N detectors). Drives the full FF pipeline from raw data to grains. |
+| `midas-nf-pipeline` | Pure-Python NF-HEDM pipeline orchestrator (single + multi-resolution, multi-layer). Drop-in for `nf_MIDAS.py` / `nf_MIDAS_Multiple_Resolutions.py`. |
+| `midas-parsl-configs` | Bundled + user-extensible Parsl configs for running MIDAS pipelines on laptops, workstations, clusters. |
+
+**FF-HEDM building blocks:**
+
+| Sub-package | Role |
+|---|---|
+| `midas-peakfit` | Differentiable PyTorch peak fitting for FF-HEDM Zarr |
+| `midas-transforms` | FF-HEDM peak transforms (merge / radius / fit-setup / save-bin) |
+| `midas-index` | Pure-Python/PyTorch FF-HEDM indexer (drop-in for `IndexerOMP`) |
+| `midas-fit-grain` | Single/multi-grain refiner |
+| `midas-process-grains` | FF-HEDM grain-determination + strain pipeline |
+
+**NF-HEDM building blocks:**
+
+| Sub-package | Role |
+|---|---|
+| `midas-nf-preprocess` | NF-HEDM preprocessing (hex grid, tomo filter, spot prediction) |
+| `midas-nf-fitorientation` | NF-HEDM orientation/calibration fitter |
+
+**Shared foundations:**
+
+| Sub-package | Role |
+|---|---|
+| `midas-stress` | Crystallographic stress/strain analysis (Voigt-Mandel, Cij inversion, slip/Schmid/Taylor) |
+| `midas-params` | Parameter-file registry, validator, wizard for FF/NF/PF/RI |
+| `midas-hkls` | Pure-Python crystallography & HKL list generator (sginfo-equivalent) |
+| `midas-diffract` | End-to-end differentiable HEDM forward model (FF + NF + pf-HEDM) |
+| `midas-integrate` | Pure-Python radial integration (`DetectorMapper` + CSR + streaming server) |
+| `midas-calibrate` | Native Python/Torch detector geometry calibration (LM-based) |
+
+You then `import midas_stress`, `import midas_diffract`, etc. directly —
+each sub-package retains its own API. `midas-suite` does not re-export
+them.
+
+To check what was installed:
+
+```python
+import midas_suite
+print(midas_suite.installed())
+```
+
+## Modality bundles
+
+If you don't want everything, the optional extras let you pick a workflow:
+
+```bash
+pip install "midas-suite[ff]"      # FF-HEDM stack
+pip install "midas-suite[nf]"      # NF-HEDM stack
+pip install "midas-suite[calib]"   # calibration + integration only
+pip install "midas-suite[ff,plots]"
+```
+
+| Extra | What it pulls |
+|---|---|
+| `ff` | `midas-ff-pipeline` (which transitively pulls hkls, peakfit, transforms, index, fit-grain, process-grains, diffract, parsl-configs) + stress, params, calibrate, integrate |
+| `nf` | `midas-nf-pipeline` (which transitively pulls hkls, stress, nf-preprocess, nf-fitorientation) + params |
+| `calib` | hkls, integrate, peakfit, calibrate |
+| `plots` | matplotlib (for sub-package plotting helpers) |
+
+## What `pip install midas-suite` does NOT include
+
+Be aware:
+
+- **The MIDAS C executables** (`IndexerOMP`, `ProcessGrains`, `MakeDiffrSpots`, …)
+  still need to be built from source via `cmake --build .` from the MIDAS
+  monorepo. The pure-Python pipeline (calibration → integration → indexing
+  → grain processing) is now end-to-end in PyTorch and does not require
+  them.
+- **The PyQt FF viewer GUI** needs `PyQt5` or `PySide6` installed
+  separately. Not declared here because it's optional and platform-sensitive.
+- **Optional crystallography backends** for `midas-hkls`: install
+  `gemmi` or `pycifrw` separately for CIF I/O via `pip install
+  midas-hkls[cif]`.
+- **GPU acceleration** is a runtime backend selected by PyTorch device
+  string. CUDA/MPS just work if your `torch` install supports them; no
+  separate `*-gpu` package needed.
+- **Coming in v0.2.0** — `midas-grain-odf` (per-grain ODF inversion) and
+  `midas-pf-odf` (joint pf-HEDM peak-shape inversion) are not yet on
+  PyPI. They fold in when `midas-suite` v0.2.0 ships, bringing the
+  bundled count to 18 sub-packages.
+
+## Cross-platform
+
+All MIDAS Python sub-packages are pure Python or PyTorch and ship as
+`py3-none-any` wheels. Tested install paths: Linux, macOS, Windows.
+See [`packages/RELEASE_READINESS.md`](../RELEASE_READINESS.md) for the
+detailed cross-platform readiness matrix.
+
+## Versioning
+
+`midas-suite` versions are independent of the sub-package versions.
+The rule:
+
+| Change | Bump |
+|---|---|
+| Floors tightened (no new sub-package added) | patch (`0.1.0` → `0.1.1`) |
+| New sub-package added to the dep list | minor (`0.1.0` → `0.2.0`) |
+| Backwards-incompatible reorganisation of bundles | major (`0.x.y` → `1.0.0`) |
+
+Floors are pinned with `>=`, never `==`, so a sub-package patch release
+doesn't break `midas-suite`.
+
+## Releasing a new version
+
+See [`RELEASING.md`](RELEASING.md) for the full release flow. TL;DR:
+
+```bash
+cd packages/midas_suite
+./release.sh 0.2.0 --publish
+```
+
+## License
+
+BSD-3-Clause, same as the sub-packages.

midas_suite-0.2.0.dist-info/RECORD

@@ -0,0 +1,5 @@
+midas_suite/__init__.py,sha256=hX_FTtt7ML6juWRpYcD0W9ONcZ-XAB1sKsqJEE9tELg,1770
+midas_suite-0.2.0.dist-info/METADATA,sha256=NJZan2NSr-6vIf4SwlE3RxUrXU6voMgjrMpxSZ0eNiU,7824
+midas_suite-0.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+midas_suite-0.2.0.dist-info/top_level.txt,sha256=-9dATWsWH0hCi8EYz8-9wn6nr3tkw10pOXkIjdDyYZQ,12
+midas_suite-0.2.0.dist-info/RECORD,,

midas_suite-0.2.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

midas_suite-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+midas_suite