xraylarch


Namexraylarch JSON
Version 2025.2.2 PyPI version JSON
download
home_pageNone
SummarySynchrotron X-ray data analysis in python
upload_time2025-07-29 12:28:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords x-ray xas xrf xrd physics fitting
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## Larch:  Data Analysis Tools for X-ray Spectroscopy and More


[![A](https://github.com/xraypy/xraylarch/actions/workflows/test-ubuntu.yml/badge.svg)](https://github.com/xraypy/xraylarch/actions/workflows/test-ubuntu.yml)
[![B](https://github.com/xraypy/xraylarch/actions/workflows/test-windows.yml/badge.svg)](https://github.com/xraypy/xraylarch/actions/workflows/test-windows.yml)


Larch is an open-source library and set of applications for
visualizing, processing, and analyzing X-ray absorption and
fluorescence spectroscopy data from synchrotron beamlines.  While its
origins and emphasis are in X-ray absorption fine-structure
spectroscopy (XAS), including X-ray absorption near-edge spectroscopy
(XANES) and extended X-ray absorption fine-structure spectroscopy
(EXAFS), it also supports visualization and analysis tools for several
related X-ray measurement modes.  These include X-ray fluorescence
(XRF) spectra and XRF and X-ray diffraction (XRD) images as collected
at scanning X-ray microprobe beamlines.

Larch is written in Python, and makes heavy use of the excellent
scientific Python libraries.  It can be used as a Python library, or
through one of several Graphical User Interfaces, including Larix, and
others listed in the table below.

Larch is distributed under the MIT licence.  It has been under active
and open development for more than a decade, and is built on XAFS
analysis tools that go back to the 1990s.  Development is done
primarily at the University of Chicago, with support from the US
National Science Foundation, and the US Departmen of Energy.

The best citable reference for Larch is https://doi.org/10.1088/1742-6596/430/1/012007

## Larch Applications

These applications installed with Larch, in addition to a basic Python
library. Here, GUI = Graphical User Interface, CLI = Command Line
Interface, and `beta` indicates a work in progress.


| Application Name  | GUI/CLI    | Description                                            |
| ----------------- |----------- | ------------------------------------------------------ |
| larch             | CLI        | simple shell command-line interface                    |
| Larch GUI         | GUI        | enhanced command-line interface with data browser      |
| Larix             | GUI        | XAFS Processing and Analysis: XANES pre-edge peak      |
|                   |            | fitting, linear analysis, PCA/LASSO, EXAFS processing  |
|                   |            | Running Feff, fitting EXAFS data to Feff paths.        |
| GSE Map Viewer    | GUI        | XRF Map Viewer for GSECARS X-ray microprobe data.      |
| larch_xrf         | GUI        | Display and analyze XRF Spectra.                       |
| larch_xrd1d       | GUI        | Display and work with 1-D XRD patterns, integrate XRD  |
|                   |            | images, search for XRD patterns of known structures    |
| feff6l            | CLI        | Feff 6 EXAFS calculations                              |
| feff8l            | CLI        | Feff 8 EXAFS calculations (no XANES)                   |
| qtrixs            | GUI `beta` | Display RIXS planes, take profiles                     |



In addition, the applications built with it also use a built-in
Python-like macro language for interactive and batch processing.  This
embedded "miniPython" language is intended to be very easy to use for
novices while also being complete enough to automate data processing
and analysis and to encourage and facilitate a gentle transition to
transition from GUI-only analyses to scripted and programmatic
analysis of larger data sets, and allows Larch to be run as a service,
interacting with other processes or languages via XML-RPC.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "xraylarch",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "X-ray, XAS, XRF, XRD, Physics, Fitting",
    "author": null,
    "author_email": "Matthew Newville <newville@cars.uchicago.edu>, Mauro Rovezzi <mauro.rovezzi@esrf.fr>, Bruce Ravel <bravel@nist.gov>, Margaret Koker <margaret.koker@lawrence.edu>",
    "download_url": "https://files.pythonhosted.org/packages/e4/34/78e5bf4d8e8cee9d5af806d323dc0ade1c63de6668859a2afc8aff892eb0/xraylarch-2025.2.2.tar.gz",
    "platform": null,
    "description": "## Larch:  Data Analysis Tools for X-ray Spectroscopy and More\n\n\n[![A](https://github.com/xraypy/xraylarch/actions/workflows/test-ubuntu.yml/badge.svg)](https://github.com/xraypy/xraylarch/actions/workflows/test-ubuntu.yml)\n[![B](https://github.com/xraypy/xraylarch/actions/workflows/test-windows.yml/badge.svg)](https://github.com/xraypy/xraylarch/actions/workflows/test-windows.yml)\n\n\nLarch is an open-source library and set of applications for\nvisualizing, processing, and analyzing X-ray absorption and\nfluorescence spectroscopy data from synchrotron beamlines.  While its\norigins and emphasis are in X-ray absorption fine-structure\nspectroscopy (XAS), including X-ray absorption near-edge spectroscopy\n(XANES) and extended X-ray absorption fine-structure spectroscopy\n(EXAFS), it also supports visualization and analysis tools for several\nrelated X-ray measurement modes.  These include X-ray fluorescence\n(XRF) spectra and XRF and X-ray diffraction (XRD) images as collected\nat scanning X-ray microprobe beamlines.\n\nLarch is written in Python, and makes heavy use of the excellent\nscientific Python libraries.  It can be used as a Python library, or\nthrough one of several Graphical User Interfaces, including Larix, and\nothers listed in the table below.\n\nLarch is distributed under the MIT licence.  It has been under active\nand open development for more than a decade, and is built on XAFS\nanalysis tools that go back to the 1990s.  Development is done\nprimarily at the University of Chicago, with support from the US\nNational Science Foundation, and the US Departmen of Energy.\n\nThe best citable reference for Larch is https://doi.org/10.1088/1742-6596/430/1/012007\n\n## Larch Applications\n\nThese applications installed with Larch, in addition to a basic Python\nlibrary. Here, GUI = Graphical User Interface, CLI = Command Line\nInterface, and `beta` indicates a work in progress.\n\n\n| Application Name  | GUI/CLI    | Description                                            |\n| ----------------- |----------- | ------------------------------------------------------ |\n| larch             | CLI        | simple shell command-line interface                    |\n| Larch GUI         | GUI        | enhanced command-line interface with data browser      |\n| Larix             | GUI        | XAFS Processing and Analysis: XANES pre-edge peak      |\n|                   |            | fitting, linear analysis, PCA/LASSO, EXAFS processing  |\n|                   |            | Running Feff, fitting EXAFS data to Feff paths.        |\n| GSE Map Viewer    | GUI        | XRF Map Viewer for GSECARS X-ray microprobe data.      |\n| larch_xrf         | GUI        | Display and analyze XRF Spectra.                       |\n| larch_xrd1d       | GUI        | Display and work with 1-D XRD patterns, integrate XRD  |\n|                   |            | images, search for XRD patterns of known structures    |\n| feff6l            | CLI        | Feff 6 EXAFS calculations                              |\n| feff8l            | CLI        | Feff 8 EXAFS calculations (no XANES)                   |\n| qtrixs            | GUI `beta` | Display RIXS planes, take profiles                     |\n\n\n\nIn addition, the applications built with it also use a built-in\nPython-like macro language for interactive and batch processing.  This\nembedded \"miniPython\" language is intended to be very easy to use for\nnovices while also being complete enough to automate data processing\nand analysis and to encourage and facilitate a gentle transition to\ntransition from GUI-only analyses to scripted and programmatic\nanalysis of larger data sets, and allows Larch to be run as a service,\ninteracting with other processes or languages via XML-RPC.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Synchrotron X-ray data analysis in python",
    "version": "2025.2.2",
    "project_urls": {
        "Documentation": "https://xraypy.github.io/xraylarch/",
        "Homepage": "https://github.com/xraypy/xraylarch",
        "Tracker": "https://github.com/xraypy/xraylarch/issues"
    },
    "split_keywords": [
        "x-ray",
        " xas",
        " xrf",
        " xrd",
        " physics",
        " fitting"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7b0548c990374cbd4769c6d2488c6f982caf568c0b2c96703d310fd24928c941",
                "md5": "e09c38a2af9adb104f0b96711302fbad",
                "sha256": "513e2c3551e221fa950b064e6c09b42939e67a06a1e96e9664b474c3d3652c34"
            },
            "downloads": -1,
            "filename": "xraylarch-2025.2.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e09c38a2af9adb104f0b96711302fbad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 17253008,
            "upload_time": "2025-07-29T12:28:33",
            "upload_time_iso_8601": "2025-07-29T12:28:33.724564Z",
            "url": "https://files.pythonhosted.org/packages/7b/05/48c990374cbd4769c6d2488c6f982caf568c0b2c96703d310fd24928c941/xraylarch-2025.2.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e43478e5bf4d8e8cee9d5af806d323dc0ade1c63de6668859a2afc8aff892eb0",
                "md5": "b53541ce4db6078d7a510d26aff03058",
                "sha256": "bbd0b4999b15b44eb5770e6c3f0887c4efbf5616c9f38d7d8b00165c2670167f"
            },
            "downloads": -1,
            "filename": "xraylarch-2025.2.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b53541ce4db6078d7a510d26aff03058",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 17587526,
            "upload_time": "2025-07-29T12:28:37",
            "upload_time_iso_8601": "2025-07-29T12:28:37.530618Z",
            "url": "https://files.pythonhosted.org/packages/e4/34/78e5bf4d8e8cee9d5af806d323dc0ade1c63de6668859a2afc8aff892eb0/xraylarch-2025.2.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-29 12:28:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "xraypy",
    "github_project": "xraylarch",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "xraylarch"
}
        
Elapsed time: 0.77813s