Metadata-Version: 2.1
Name: xlum
Version: 0.0.8
Summary: python importer for the XLUM data exchange and archive format
Home-page: https://github.com/SteveGrehl/xlum-python
Author: Steve Grehl
Author-email: research@steve-grehl.eu
License: MIT
Keywords: xlum,luminescence
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Provides-Extra: notebook
Provides-Extra: test
License-File: LICENSE

# xlum-python <img width=120px src="docs/img/xlum-python_logo.png" align="right" />

Python importer for the [XLUM data exchange and archive format](https://github.com/R-Lum/xlum_specification)

## System requirements

- lxml https://pypi.org/project/lxml/
- pandas https://pandas.pydata.org/
- urllib3 https://urllib3.readthedocs.io/en/stable/
- openpyxl https://openpyxl.readthedocs.io/en/stable/
- Access to GitHub for XSD schema validation
  
## Installation

```console
$ pip install xlum
```

## Usage
```python
import xlum

meta_obj = xlum.from_xlum(file_name="<Path to Xlum>")
```

## Citing
```
@Article{gchron-2022-27,
    AUTHOR = {Kreutzer, S. and Grehl, S. and H\"ohne, M. and Simmank, O. and Dornich, K. and Adamiec, G. and Burow, C. and Roberts, H. and Duller, G.},
    TITLE = {XLUM: an open data format for exchange and long-term data preservation of luminescence data},
    JOURNAL = {Geochronology Discussions},
    VOLUME = {2022},
    YEAR = {2022},
    PAGES = {1--22},
    URL = {https://gchron.copernicus.org/preprints/gchron-2022-27/},
    DOI = {10.5194/gchron-2022-27}
}
```

## Funding

The development of the XLUM-format as format basis for reference data was supported by the European Union’s Horizon 2020 research and innovation programme under the Marie Skłodowska-Curie grant agreement No 844457 [CREDit](https://cordis.europa.eu/project/id/844457)).
