https://github.com/maurov/xraysloth
sloth: slowly evolving utilities for x-ray spectroscopists
https://github.com/maurov/xraysloth
data-analysis python ray-tracing synchrotron x-ray-absorption-fine-structure x-ray-absorption-spectroscopy x-ray-diffraction x-ray-emission-spectroscopy x-ray-instrumentation x-ray-optics x-ray-physics x-ray-spectroscopy
Last synced: about 2 months ago
JSON representation
sloth: slowly evolving utilities for x-ray spectroscopists
- Host: GitHub
- URL: https://github.com/maurov/xraysloth
- Owner: maurov
- Created: 2014-08-29T08:13:34.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2026-03-16T14:59:52.000Z (3 months ago)
- Last Synced: 2026-03-17T02:37:11.394Z (3 months ago)
- Topics: data-analysis, python, ray-tracing, synchrotron, x-ray-absorption-fine-structure, x-ray-absorption-spectroscopy, x-ray-diffraction, x-ray-emission-spectroscopy, x-ray-instrumentation, x-ray-optics, x-ray-physics, x-ray-spectroscopy
- Language: Python
- Homepage: https://xraysloth.readthedocs.io/
- Size: 11.4 MB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Sloth: slowly evolving utilities for x-ray spectroscopy
=======================================================
Sloth is a collection of Python scripts, examples of workflows and documentation
that may result useful in the field of **x-ray instrumentation, optics and
spectroscopy**. The project aims providing a dedicated Python environment
(called `sloth`) for scientists working on X-ray spectroscopy beamlines. It
should help with the tasks of data reduction/analysis and simulation for X-ray
Absorption Spectroscopy (XAS, XANES/EXAFS, HERFD-*), X-ray emission spectroscopy
(XES) and Resonant Inelastic X-ray Scattering (RIXS) techniques.
Sloth is lazy by nature and tries reusing as much as possible the existing
open-source libraries of the Python ecosystem. It results in a large number of
dependecies. Nevertheless, apart few very basic libraries that are mandatory,
many other are used randomly in specific modules and you may discover them only
by usage, so I strongly encourage to read the code and the documentation.
Sloth is designed as a **Python environment running on a Linux-like
(virtual)machine** (see Installation in the documentation for a full
description). On top of this, there is a basic library and some rudimentary
not-yet-finished GUIs. The structure of the code or the API is changing rapidily
and *backward compatibility is not guarenteed*. Thus, the library performs as a
partial random snapshot of daily work/research and still-to-implement ideas
(mainly due to lack of time). Feel free to use/hack it and do not hesitate to
drop me a line if you find any script useful. Furthermore, I appreciate if bugs,
enhancements or comments could be reported directly in `Github Issues
`_
This project works in close collaboration with `Larch
`_ and the goal is to transfer stable
portions of the code there. It means that **it is recommended to use Larch in
production environments**.
Finally, I recommend visiting the `Sloth appreciation society
`_ and I acknowledge them for inspiring the logo.
Resources
---------
- **Documentation**: https://xraysloth.readthedocs.io |rtd|
- Documentation (*backup*): http://mauro.rovezzi.net/xraysloth |travis|
- Citation: |zenodo|
- License: |license|
- BinderHub (*experimental*): |binder|
.. |license| image:: https://img.shields.io/github/license/maurov/xraysloth.svg
:target: https://github.com/maurov/xraysloth/blob/master/LICENSE.txt
:alt: License
.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.821221.svg
:target: https://doi.org/10.5281/zenodo.821221
:alt: Citation DOI
.. |travis| image:: https://travis-ci.org/maurov/xraysloth.svg?branch=master
:target: https://travis-ci.org/maurov/xraysloth
:alt: Travis-CI status
.. |rtd| image:: https://readthedocs.org/projects/xraysloth/badge/?version=latest
:target: https://xraysloth.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |binder| image:: https://img.shields.io/badge/launch-sloth-579ACA.svg
:target: https://mybinder.org/v2/gh/maurov/xraysloth/master?filepath=notebooks%2Findex.ipynb
:alt: Launch Sloth on Binder