evefile 0.1.0__py3-none-any.whl

evefile-0.1.0.dist-info/METADATA

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: evefile
+Version: 0.1.0
+Summary: Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin
+Home-page: https://www.ptb.de/cms/en/ptb/fachabteilungen/abt7/ptb-sr.html
+Author: Till Biskup
+Author-email: till.biskup@ptb.de
+License: GPLv3
+Project-URL: Documentation, https://evefile.docs.radiometry.de/
+Project-URL: Source, https://github.com/tillbiskup/evefile
+Keywords: eve,radiometry,synchrotron,PTB,BESSY,MLS
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Science/Research
+Classifier: Development Status :: 4 - Beta
+Requires-Python: >=3.7
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: COPYING
+Requires-Dist: h5py
+Requires-Dist: numpy
+Requires-Dist: pandas
+Provides-Extra: dev
+Requires-Dist: prospector; extra == "dev"
+Requires-Dist: pyroma; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: pymetacode; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Requires-Dist: sphinx_multiversion; extra == "docs"
+Provides-Extra: deployment
+Requires-Dist: build; extra == "deployment"
+Requires-Dist: twine; extra == "deployment"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.16815768.svg
+   :target: https://doi.org/10.5281/zenodo.16815768
+   :align: right
+
+=======
+evefile
+=======
+
+*Transitional package to read eveH5 files containing synchrotron radiometry data recorded at BESSY/MLS in Berlin.*
+
+Welcome! This is evefile, a Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. This package acts as *transitional* interface between the (eveH5) data files and the processing and analysis code. For related packages for importing, viewing, and analysing those data, have a look at the "related projects" section below.
+
+Loading the contents of a data file of a measurement is as simple as::
+
+    import evefile
+
+    file = evefile.EveFile(filename="my_measurement_file.h5")
+
+Here, ``file`` contains all the information contained in the data file as a hierarchy of Python objects.
+
+
+Features
+========
+
+A list of features:
+
+* Importer for eve HDF5 files (used at PTB in Berlin, Germany)
+
+* Fully backwards-compatible to older eveH5 versions
+
+* Complete information available that is contained in an eveH5 file
+
+* Data are (only) loaded on demand, not when loading the file
+
+* Powerful and intuitive abstractions, allowing for associative access to data and information – beyond a purely tabular view of the data
+
+
+And to make it even more convenient for users and future-proof:
+
+* Open source project written in Python (>= 3.9)
+
+* Developed fully test-driven
+
+* Extensive user and API documentation
+
+
+Installation
+============
+
+To install the evefile package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following::
+
+    pip install evefile
+
+
+Related projects
+================
+
+There is a number of related packages users of the evedata package may well be interested in, as they have a similar scope, focussing on working with synchrotron radiometry data.
+
+* `evedata <https://evedata.docs.radiometry.de>`_
+
+  A Python package for **importing (synchrotron) radiometry data** obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_. In contrast to ``evefile``, this package will provide powerful and intuitive abstractions, allowing for associative access to data and information. Hence, ``evefile`` is only a transitional package for use until ``evedata`` is considered sufficiently stable for routine use.
+
+* `radiometry <https://docs.radiometry.de>`_
+
+  A Python package for **processing and analysing (synchrotron) radiometry data** in a **reproducible** and mostly **automated** fashion. Currently, it focusses on data obtained at one of the beamlines at **BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.
+
+* `evedataviewer <https://evedataviewer.docs.radiometry.de>`_
+
+  A Python package for **graphically inspecting data** contained in EVE files, *i.e.* data **obtained at one of the beamlines at BESSY-II or MLS in Berlin**, mostly operated by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt (PTB) <https://www.ptb.de/>`_.
+
+
+License
+=======
+
+This program is free software: you can redistribute it and/or modify it under the terms of the **GPLv3 License**. See the file ``LICENSE`` for more details.

evefile-0.1.0.dist-info/RECORD

@@ -0,0 +1,30 @@
+evefile/__init__.py,sha256=DtUfummsLsWO7A-xiqL1hUEBll8Qc1z7829P9Sb0kOk,215
+evefile/__pycache__/__init__.cpython-311.pyc,sha256=RkdWBYZ3wcT04KJ8H7KPKwhPhMc-GV9vbGSuOIOtqjE,398
+evefile/boundaries/__init__.py,sha256=OKIxX1YeMY3Bda2g27xm-uQwH191EL6qLIHoPIoz_88,64
+evefile/boundaries/evefile.py,sha256=yV-HX_eqadEy4rCYWJB8GVx-ArVr4tRFswFej12xZqs,24719
+evefile/boundaries/eveh5.py,sha256=u-aEXXBoQYCfKb7l7w1x2VVKlQ2mT5S8gMdLiHZteYU,29750
+evefile/boundaries/__pycache__/__init__.cpython-311.pyc,sha256=GnLdTDzJRRVDQg_l9nctkGQs0GU8oILd3Lg1XY7kKhg,251
+evefile/boundaries/__pycache__/evefile.cpython-311.pyc,sha256=tKhDoKGchjHCg2LXiqlLAWvJrpWrYV-ewB-S_Gyfb3c,29654
+evefile/boundaries/__pycache__/eveh5.cpython-311.pyc,sha256=IpaPRhZkmdR-z6x257TujkwRgAeyuhPwAn7NnvslNJM,35831
+evefile/controllers/__init__.py,sha256=K4ysYHyf7p5dFDIppJyx8-ydZpLfwvjoikhUcOapKuQ,147
+evefile/controllers/joining.py,sha256=sTj4kqviC_C5KXRZMiz-rR80fVoPMZFfbNR0gH0YM0g,42275
+evefile/controllers/timestamp_mapping.py,sha256=mqD3bugpP68xFJa4yjgTgKJ6IXdIL7kcAjO_PdJNxoI,6886
+evefile/controllers/version_mapping.py,sha256=zplXv7lKvvzd0NI1pMpavVFCdrkauXBnT_uvXTJu8PQ,41958
+evefile/controllers/__pycache__/__init__.cpython-311.pyc,sha256=OAlQR88n3ns13ecANQdSyPZ4w0F350NhCicFxjMAJmw,356
+evefile/controllers/__pycache__/joining.cpython-311.pyc,sha256=mMhrc7PNzV5irZUXtdDsJhbAE7uVph88OJCkHG02kTE,48178
+evefile/controllers/__pycache__/timestamp_mapping.cpython-311.pyc,sha256=AXFP-ezVo2ssZVj5CPAgYrKkCyA9rxG-jJNGYrjjfL8,7772
+evefile/controllers/__pycache__/version_mapping.cpython-311.pyc,sha256=rQ-M_O5po_E3bwjbG200AdZBT_g8N0WShDX-BFpYKl4,52416
+evefile/entities/__init__.py,sha256=VfS-6fdCiqlYobw7gcCMcfdm8Fct_6AnSPw99JHV2bo,170
+evefile/entities/data.py,sha256=GsV39nrkejJ3hcnzbJkj8Lyk_dqQUmWI8-72y1FUCxI,61638
+evefile/entities/file.py,sha256=grOHe2ONwieh58imbEq1ahLZyXooardctNanvcuWOJs,9816
+evefile/entities/metadata.py,sha256=DVgLWM3bob2JWh_wpf6jGJ6LnIRsErB_AJmOx-u_P3E,18111
+evefile/entities/__pycache__/__init__.cpython-311.pyc,sha256=Rc8OF9IeRYpJbN7Qw5AFn5qPxm7g_carXQKqnuZUHz4,380
+evefile/entities/__pycache__/data.cpython-311.pyc,sha256=03Dlb4-IPmnHVjiq8QDyEXpDJ7odY7X4fDKTnmtcXTM,75636
+evefile/entities/__pycache__/file.cpython-311.pyc,sha256=scDx1m5UN-HcCqAArH3Gzw-tSjE0fWSiiTzR8xTSlfg,11764
+evefile/entities/__pycache__/metadata.cpython-311.pyc,sha256=sJLio3ys7pokbUr1khZsTBCU-2_1zbn2JMu9-NEk5e0,24716
+evefile-0.1.0.dist-info/licenses/COPYING,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+evefile-0.1.0.dist-info/licenses/LICENSE,sha256=VYLxbjlmThdMWJAgeCXSLlcHUDR0kk0C40P92FH3o3M,766
+evefile-0.1.0.dist-info/METADATA,sha256=oKfp7d_z-sPZnFyaKCtWzNBDoGbgu0--VcuikFXjOO0,5598
+evefile-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+evefile-0.1.0.dist-info/top_level.txt,sha256=AiXT2Ch6ZWznVmfIXckmjoPXMfucyXMj4SP_46hKN7s,8
+evefile-0.1.0.dist-info/RECORD,,

evefile-0.1.0.dist-info/WHEEL

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