lcmodel-wrapper 0.1.2__tar.gz → 0.3.0__tar.gz

lcmodel_wrapper-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Julian Merkofer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lcmodel_wrapper-0.3.0/LICENSE.lcmodel

@@ -0,0 +1,39 @@
+LCModel license
+===============
+
+This project (PyLCModel / lcmodel_wrapper) is a Python wrapper. It does NOT
+contain the original LCModel program in its own copyright. LCModel is a separate
+work distributed under the BSD 3-Clause License reproduced below. When the
+wrapper downloads, builds, or otherwise redistributes the LCModel executable or
+its Fortran source, the following license and notice apply to that component.
+
+Copyright (c) 1992-2021, Stephen Provencher
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+ 3. Neither the name of the copyright holder nor the names of its
+    contributors may be used to endorse or promote products derived from
+    this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Reference: S.W. Provencher (1993) Magn. Reson. Med. 30, 672-679.
+LCModel home page: https://s-provencher.com/lcmodel.shtml

lcmodel_wrapper-0.3.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include LICENSE.lcmodel
+include NOTICE
+include README.md

lcmodel_wrapper-0.3.0/NOTICE

@@ -0,0 +1,24 @@
+PyLCModel (lcmodel_wrapper)
+Copyright (c) 2024 Julian P. Merkofer and contributors
+
+Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+------------------------------------------------------------------------------
+LCModel
+------------------------------------------------------------------------------
+
+LCModel is NOT part of this project's copyright. It is a separate program by
+Dr. Stephen Provencher, distributed under the BSD 3-Clause License
+(Copyright (c) 1992-2021, Stephen Provencher); see LICENSE.lcmodel for the
+full text. Home page: https://s-provencher.com/lcmodel.shtml
+
+This wrapper bundles no LCModel code or binary. At run time it may obtain one
+from these sources, and the BSD 3-Clause license applies to every one of them:
+
+  - the community binary collection at https://github.com/schorschinho/LCModel
+    (maintained by Georg Oeltzschner and contributors),
+  - binaries and the container image ghcr.io/julianmer/lcmodel built by this
+    repository's CI (.github/workflows/lcmodel-binaries.yml) from the pinned
+    upstream source, unmodified, using the compilation flags documented there;
+    LICENSE.lcmodel and this NOTICE are published alongside them,
+  - a local build from the same source via gfortran.

lcmodel_wrapper-0.3.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: lcmodel_wrapper
+Version: 0.3.0
+Summary: Lightweight Python wrapper for LCModel MRS fitting
+Author-email: Julian Merkofer <j.p.merkofer@tue.nl>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/julianmer/PyLCModel
+Project-URL: Repository, https://github.com/julianmer/PyLCModel
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE.lcmodel
+License-File: NOTICE
+Requires-Dist: numpy>=1.22
+Requires-Dist: scipy>=1.10
+Requires-Dist: nibabel>=4.0
+Requires-Dist: nifti-mrs>=1.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pandas>=1.4; extra == "test"
+Requires-Dist: openpyxl>=3.0; extra == "test"
+Dynamic: license-file
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/julianmer/PyLCModel/main/assets/logo_grey.png" alt="PyLCModel Logo" width="160"/>
+  <h1 style="margin-top:-10px; margin-bottom: 5px;">PyLCModel</h1>
+  <p style="margin-top: 0px;"><em>A lightweight Python wrapper for LCModel spectral fitting in MR spectroscopy</em></p>
+
+  [![PyPI version](https://badge.fury.io/py/lcmodel-wrapper.svg)](https://pypi.org/project/lcmodel-wrapper/)
+  [![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+  [![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
+</div>
+
+**PyLCModel** is a lightweight Python wrapper that streamlines the use of [LCModel](https://s-provencher.com/lcmodel.shtml) for least-squares spectral fitting in MRS. It automates control-file generation, handles flexible data input, manages the LCModel executable for you, and parses the output (with single- and multi-core processing).
+
+---
+
+## Features
+
+- **Zero-setup binaries** — the LCModel executable is resolved automatically (download, container image, build from source, or your own path); nothing is bundled in the wheel.
+- **Flexible input** — NumPy arrays, NIfTI-MRS, jMRUI text, and LCModel `.RAW`, in time or frequency domain.
+- **Automated control files** — generated to match your data, or templated from an existing one.
+- **Basis conversion (experimental)** — jMRUI, FSL-MRS, LCModel `.RAW`, and Osprey/FID-A basis sets to `.basis`.
+- **Batch fitting** — single- or multi-core, with full output parsing (concentrations, CRLBs, QC, fitted series).
+
+---
+
+## Installation
+
+### From PyPI
+```bash
+pip install lcmodel-wrapper
+```
+
+### From Source
+```bash
+git clone https://github.com/julianmer/PyLCModel.git
+cd PyLCModel
+pip install -e .
+```
+Add `--recursive` to the clone (or run `git submodule update --init`) to also fetch the
+[ISMRM 2016 fitting challenge](https://www.ismrm.org/workshops/Spectroscopy16/mrs_fitting_challenge/)
+example data used by the tests.
+
+---
+
+## How the LCModel binary is handled
+
+The LCModel program is **not** part of this package and is **not** shipped in the wheel. On first use, the binary is resolved in this order:
+
+1. an explicit `path2exec="/path/to/lcmodel"` you pass to `PyLCModel`,
+2. a previously cached download/build (under `~/.cache/lcmodel_wrapper/<os>-<arch>/`, or `%LOCALAPPDATA%` on Windows; override the root with `LCMODEL_CACHE_DIR`),
+3. a download of the matching binary for your OS/architecture from [schorschinho/LCModel](https://github.com/schorschinho/LCModel),
+4. a download of the binary built by this repository's CI and attached to the [GitHub release](https://github.com/julianmer/PyLCModel/releases) matching the installed package version (Linux x86_64/aarch64 fully static, macOS arm64/x86_64 with libgfortran linked statically; each verified against its published SHA-256),
+5. **a container** — if `docker` (or `podman`) is installed and running, the image `ghcr.io/julianmer/lcmodel` is pulled and a small launcher script is cached that runs LCModel from it (Linux, macOS, and Windows),
+6. a build from the LCModel Fortran source via `gfortran` (source fetched on demand).
+
+Every candidate is **run once before it is accepted** — LCModel is asked to identify itself, and anything that cannot execute or does not answer is moved to `<cache>/quarantine/` so the next source gets a turn. This is what stops a wrong-architecture download from being cached and served forever. Set `LCMODEL_SKIP_VERIFY=1` to bypass the check, or `LCMODEL_VERIFY_TIMEOUT` to change its 60 s bound.
+
+The cache is keyed by architecture, so a home directory shared across a mixed-architecture cluster does not have nodes fighting over one file.
+
+### Running from a container
+
+The container is the one option that behaves identically everywhere: inside it LCModel is always the same statically linked Linux binary, so nothing depends on your macOS version, Homebrew, or which Apple-silicon generation you have (upstream's macOS builds are tied to the machine they were compiled on, which is why an M1 build does not run on an M4). Docker Desktop, OrbStack, Colima, or rootless podman all work.
+
+On Linux and macOS the launcher bind-mounts your **working directory** and your **home directory** at the same paths inside the container, so the absolute paths in the control file need no translation. On Windows it mounts the **drives** holding those two at `/host/<LETTER>` and the wrapper rewrites the file paths in the control file to match (`C:\Users\me\x.basis` → `/host/C/Users/me/x.basis`); UNC paths are not supported. The one constraint: the basis set and any absolute `save_path` must live under the working or home directory (on Windows: on one of their drives); `PyLCModel` raises a clear error otherwise.
+
+```python
+lcmodel = PyLCModel(path2basis="~/basis/press_3t.basis")        # container used automatically if needed
+lcmodel = PyLCModel(path2basis="...", allow_docker=False)        # never use a container
+```
+
+Environment knobs: `LCMODEL_NO_DOCKER=1` disables the rung, `LCMODEL_DOCKER_IMAGE` overrides the image (e.g. a locally built one), `LCMODEL_PULL_TIMEOUT` bounds the pull (default 900 s), and `LCMODEL_RELEASE_TAG` selects which release (and matching image tag) steps 4 and 5 use instead of the default `v<package version>`. Delete `<cache>/lcmodel-container` to make the resolver try the native sources again.
+
+You can also use the image directly, without Python:
+```bash
+docker run --rm -i -v "$PWD:$PWD" -w "$PWD" ghcr.io/julianmer/lcmodel:latest < control.file
+```
+
+No LCModel code or binary is bundled — keeping both the repository and the PyPI wheel small. (The only git submodule in this repository is the optional example data under `example_data/`.)
+
+---
+
+## Getting Started
+
+```python
+from lcmodel_wrapper import PyLCModel
+
+# Initialize the wrapper with your basis set (the LCModel binary is resolved automatically)
+lcmodel = PyLCModel(path2basis="/path/to/your/basis_set.basis")
+
+# `data` can be a NumPy array of FIDs (time domain), a NIfTI-MRS path, etc.
+concentrations, crlbs = lcmodel(data)
+
+print("Fitted Metabolite Concentrations:", concentrations)
+print("CRLBs:", crlbs)
+```
+
+Frequency-domain input or a custom executable:
+```python
+lcmodel = PyLCModel(
+    path2basis="/path/to/basis.basis",
+    domain="freq",                 # pass spectra instead of FIDs
+    path2exec="/path/to/lcmodel",  # optional: use your own binary
+)
+```
+
+Experimental basis conversion (other formats -> `.basis`):
+```python
+# Auto-detect the source format (jMRUI/AQSES/QUEST .txt folder, FSL-MRS .json folder,
+# LCModel .RAW folder, or Osprey/FID-A .mat):
+lcmodel = PyLCModel(path2basis="/path/to/basis_folder", convert_basis=True)
+
+# ...or force a format and supply parameters the source does not carry:
+lcmodel = PyLCModel(
+    path2basis="/path/to/raw_folder",
+    convert_basis=True,
+    basis_format="raw",          # "jmrui" | "fsl" | "raw" | "mat"
+    bandwidth=4000, central_freq=123.25,
+)
+
+# Or convert directly without fitting:
+from lcmodel_wrapper import convert_to_basis
+convert_to_basis("/path/to/jmrui_folder", out_path="out.basis")
+```
+> Basis conversion is **experimental** and not validated. For a dedicated, more complete tool, see the [MRS Basis Set Conversion Toolbox](https://github.com/igweckay/MRS-Basis-Set-Conversion-Toolbox).
+
+---
+
+## Licensing
+
+This wrapper (the Python code) is released under the **Apache License 2.0** (see [LICENSE](LICENSE)).
+
+**LCModel itself is a separate program** by Dr. Stephen Provencher, distributed under the **BSD 3-Clause License** (see [LICENSE.lcmodel](LICENSE.lcmodel)). This package does not bundle LCModel; when it downloads, builds, or runs the LCModel executable, that BSD-3-Clause license and the attributions in [NOTICE](NOTICE) apply. See the [LCModel home page](https://s-provencher.com/lcmodel.shtml) for details.
+
+---
+
+## Acknowledgements
+
+- LCModel source code: created and made [available](https://s-provencher.com/lcmodel.shtml) free of charge (Stephen Provencher).
+- LCModel binaries: [schorschinho/LCModel](https://github.com/schorschinho/LCModel) (Georg Oeltzschner and contributors)
+- Basis conversion reference: [MRS Basis Set Conversion Toolbox](https://github.com/igweckay/MRS-Basis-Set-Conversion-Toolbox) (Kay Igwe)
+- NIfTI-MRS: [spec2nii](https://github.com/wtclarke/spec2nii), [NIfTI-MRS Python tools](https://github.com/wtclarke/nifti_mrs_tools) (Will Clarke)
+- Example data: [ISMRM 2016 MRS Fitting Challenge](https://www.ismrm.org/workshops/Spectroscopy16/mrs_fitting_challenge/) (Małgorzata Marjańska, Dinesh Deelchand, Roland Kreis), mirrored via [wtclarke/mrs_fitting_challenge](https://github.com/wtclarke/mrs_fitting_challenge)
+
+---
+
+<div align="center">
+  <sub>Built with ❤️ for the MRS community</sub>
+</div>

lcmodel_wrapper-0.3.0/README.md

@@ -0,0 +1,147 @@
+<div align="center">
+  <img src="https://raw.githubusercontent.com/julianmer/PyLCModel/main/assets/logo_grey.png" alt="PyLCModel Logo" width="160"/>
+  <h1 style="margin-top:-10px; margin-bottom: 5px;">PyLCModel</h1>
+  <p style="margin-top: 0px;"><em>A lightweight Python wrapper for LCModel spectral fitting in MR spectroscopy</em></p>
+
+  [![PyPI version](https://badge.fury.io/py/lcmodel-wrapper.svg)](https://pypi.org/project/lcmodel-wrapper/)
+  [![Python](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+  [![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
+</div>
+
+**PyLCModel** is a lightweight Python wrapper that streamlines the use of [LCModel](https://s-provencher.com/lcmodel.shtml) for least-squares spectral fitting in MRS. It automates control-file generation, handles flexible data input, manages the LCModel executable for you, and parses the output (with single- and multi-core processing).
+
+---
+
+## Features
+
+- **Zero-setup binaries** — the LCModel executable is resolved automatically (download, container image, build from source, or your own path); nothing is bundled in the wheel.
+- **Flexible input** — NumPy arrays, NIfTI-MRS, jMRUI text, and LCModel `.RAW`, in time or frequency domain.
+- **Automated control files** — generated to match your data, or templated from an existing one.
+- **Basis conversion (experimental)** — jMRUI, FSL-MRS, LCModel `.RAW`, and Osprey/FID-A basis sets to `.basis`.
+- **Batch fitting** — single- or multi-core, with full output parsing (concentrations, CRLBs, QC, fitted series).
+
+---
+
+## Installation
+
+### From PyPI
+```bash
+pip install lcmodel-wrapper
+```
+
+### From Source
+```bash
+git clone https://github.com/julianmer/PyLCModel.git
+cd PyLCModel
+pip install -e .
+```
+Add `--recursive` to the clone (or run `git submodule update --init`) to also fetch the
+[ISMRM 2016 fitting challenge](https://www.ismrm.org/workshops/Spectroscopy16/mrs_fitting_challenge/)
+example data used by the tests.
+
+---
+
+## How the LCModel binary is handled
+
+The LCModel program is **not** part of this package and is **not** shipped in the wheel. On first use, the binary is resolved in this order:
+
+1. an explicit `path2exec="/path/to/lcmodel"` you pass to `PyLCModel`,
+2. a previously cached download/build (under `~/.cache/lcmodel_wrapper/<os>-<arch>/`, or `%LOCALAPPDATA%` on Windows; override the root with `LCMODEL_CACHE_DIR`),
+3. a download of the matching binary for your OS/architecture from [schorschinho/LCModel](https://github.com/schorschinho/LCModel),
+4. a download of the binary built by this repository's CI and attached to the [GitHub release](https://github.com/julianmer/PyLCModel/releases) matching the installed package version (Linux x86_64/aarch64 fully static, macOS arm64/x86_64 with libgfortran linked statically; each verified against its published SHA-256),
+5. **a container** — if `docker` (or `podman`) is installed and running, the image `ghcr.io/julianmer/lcmodel` is pulled and a small launcher script is cached that runs LCModel from it (Linux, macOS, and Windows),
+6. a build from the LCModel Fortran source via `gfortran` (source fetched on demand).
+
+Every candidate is **run once before it is accepted** — LCModel is asked to identify itself, and anything that cannot execute or does not answer is moved to `<cache>/quarantine/` so the next source gets a turn. This is what stops a wrong-architecture download from being cached and served forever. Set `LCMODEL_SKIP_VERIFY=1` to bypass the check, or `LCMODEL_VERIFY_TIMEOUT` to change its 60 s bound.
+
+The cache is keyed by architecture, so a home directory shared across a mixed-architecture cluster does not have nodes fighting over one file.
+
+### Running from a container
+
+The container is the one option that behaves identically everywhere: inside it LCModel is always the same statically linked Linux binary, so nothing depends on your macOS version, Homebrew, or which Apple-silicon generation you have (upstream's macOS builds are tied to the machine they were compiled on, which is why an M1 build does not run on an M4). Docker Desktop, OrbStack, Colima, or rootless podman all work.
+
+On Linux and macOS the launcher bind-mounts your **working directory** and your **home directory** at the same paths inside the container, so the absolute paths in the control file need no translation. On Windows it mounts the **drives** holding those two at `/host/<LETTER>` and the wrapper rewrites the file paths in the control file to match (`C:\Users\me\x.basis` → `/host/C/Users/me/x.basis`); UNC paths are not supported. The one constraint: the basis set and any absolute `save_path` must live under the working or home directory (on Windows: on one of their drives); `PyLCModel` raises a clear error otherwise.
+
+```python
+lcmodel = PyLCModel(path2basis="~/basis/press_3t.basis")        # container used automatically if needed
+lcmodel = PyLCModel(path2basis="...", allow_docker=False)        # never use a container
+```
+
+Environment knobs: `LCMODEL_NO_DOCKER=1` disables the rung, `LCMODEL_DOCKER_IMAGE` overrides the image (e.g. a locally built one), `LCMODEL_PULL_TIMEOUT` bounds the pull (default 900 s), and `LCMODEL_RELEASE_TAG` selects which release (and matching image tag) steps 4 and 5 use instead of the default `v<package version>`. Delete `<cache>/lcmodel-container` to make the resolver try the native sources again.
+
+You can also use the image directly, without Python:
+```bash
+docker run --rm -i -v "$PWD:$PWD" -w "$PWD" ghcr.io/julianmer/lcmodel:latest < control.file
+```
+
+No LCModel code or binary is bundled — keeping both the repository and the PyPI wheel small. (The only git submodule in this repository is the optional example data under `example_data/`.)
+
+---
+
+## Getting Started
+
+```python
+from lcmodel_wrapper import PyLCModel
+
+# Initialize the wrapper with your basis set (the LCModel binary is resolved automatically)
+lcmodel = PyLCModel(path2basis="/path/to/your/basis_set.basis")
+
+# `data` can be a NumPy array of FIDs (time domain), a NIfTI-MRS path, etc.
+concentrations, crlbs = lcmodel(data)
+
+print("Fitted Metabolite Concentrations:", concentrations)
+print("CRLBs:", crlbs)
+```
+
+Frequency-domain input or a custom executable:
+```python
+lcmodel = PyLCModel(
+    path2basis="/path/to/basis.basis",
+    domain="freq",                 # pass spectra instead of FIDs
+    path2exec="/path/to/lcmodel",  # optional: use your own binary
+)
+```
+
+Experimental basis conversion (other formats -> `.basis`):
+```python
+# Auto-detect the source format (jMRUI/AQSES/QUEST .txt folder, FSL-MRS .json folder,
+# LCModel .RAW folder, or Osprey/FID-A .mat):
+lcmodel = PyLCModel(path2basis="/path/to/basis_folder", convert_basis=True)
+
+# ...or force a format and supply parameters the source does not carry:
+lcmodel = PyLCModel(
+    path2basis="/path/to/raw_folder",
+    convert_basis=True,
+    basis_format="raw",          # "jmrui" | "fsl" | "raw" | "mat"
+    bandwidth=4000, central_freq=123.25,
+)
+
+# Or convert directly without fitting:
+from lcmodel_wrapper import convert_to_basis
+convert_to_basis("/path/to/jmrui_folder", out_path="out.basis")
+```
+> Basis conversion is **experimental** and not validated. For a dedicated, more complete tool, see the [MRS Basis Set Conversion Toolbox](https://github.com/igweckay/MRS-Basis-Set-Conversion-Toolbox).
+
+---
+
+## Licensing
+
+This wrapper (the Python code) is released under the **Apache License 2.0** (see [LICENSE](LICENSE)).
+
+**LCModel itself is a separate program** by Dr. Stephen Provencher, distributed under the **BSD 3-Clause License** (see [LICENSE.lcmodel](LICENSE.lcmodel)). This package does not bundle LCModel; when it downloads, builds, or runs the LCModel executable, that BSD-3-Clause license and the attributions in [NOTICE](NOTICE) apply. See the [LCModel home page](https://s-provencher.com/lcmodel.shtml) for details.
+
+---
+
+## Acknowledgements
+
+- LCModel source code: created and made [available](https://s-provencher.com/lcmodel.shtml) free of charge (Stephen Provencher).
+- LCModel binaries: [schorschinho/LCModel](https://github.com/schorschinho/LCModel) (Georg Oeltzschner and contributors)
+- Basis conversion reference: [MRS Basis Set Conversion Toolbox](https://github.com/igweckay/MRS-Basis-Set-Conversion-Toolbox) (Kay Igwe)
+- NIfTI-MRS: [spec2nii](https://github.com/wtclarke/spec2nii), [NIfTI-MRS Python tools](https://github.com/wtclarke/nifti_mrs_tools) (Will Clarke)
+- Example data: [ISMRM 2016 MRS Fitting Challenge](https://www.ismrm.org/workshops/Spectroscopy16/mrs_fitting_challenge/) (Małgorzata Marjańska, Dinesh Deelchand, Roland Kreis), mirrored via [wtclarke/mrs_fitting_challenge](https://github.com/wtclarke/mrs_fitting_challenge)
+
+---
+
+<div align="center">
+  <sub>Built with ❤️ for the MRS community</sub>
+</div>

lcmodel_wrapper-0.3.0/lcmodel_wrapper/__init__.py

@@ -0,0 +1,31 @@
+"""PyLCModel - a lightweight Python wrapper for the LCModel MRS fitting tool.
+
+LCModel itself is a separate program by Dr. Stephen Provencher, distributed under the
+BSD 3-Clause License (see LICENSE.lcmodel). This package only wraps it.
+"""
+
+from ._version import __version__
+from .core import PyLCModel, LCModelError
+from .basis import read_basis, LCModelBasis
+from .binaries import verify_executable
+from .convert import ensure_basis, convert_to_basis, detect_format
+from .io import from_nifti_mrs, load_signals
+from . import binaries, container, io, control, coord, convert
+
+__all__ = [
+    "PyLCModel",
+    "LCModelError",
+    "verify_executable",
+    "read_basis",
+    "LCModelBasis",
+    "ensure_basis",
+    "convert_to_basis",
+    "detect_format",
+    "from_nifti_mrs",
+    "load_signals",
+    "binaries",
+    "io",
+    "control",
+    "coord",
+    "convert",
+]

lcmodel_wrapper-0.3.0/lcmodel_wrapper/_version.py

@@ -0,0 +1,4 @@
+# Single source of truth for the package version. pyproject.toml reads it at build time,
+# and binaries.py derives the GitHub release / container image tag ("v<version>") from
+# it, so every wheel pairs with the LCModel artifacts built alongside it.
+__version__ = "0.3.0"