Metadata-Version: 2.1
Name: ocdb
Version: 0.1.1
Summary: Optical constants for elements and various materials in the EUV and VUV wavelengths
Home-page: https://www.ocdb.ptb.de/
Author: Till Biskup
Author-email: till.biskup@ptb.de
License: GPLv3
Project-URL: Documentation, https://ocdb-data.readthedocs.io/
Project-URL: Source, https://github.com/PTB-SR/ocdb
Keywords: optical constants,EUV,VUV,reflectometry
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.9
Description-Content-Type: text/x-rst
License-File: LICENSE
License-File: COPYING
Requires-Dist: bibrecord >=0.2.2
Requires-Dist: numpy
Requires-Dist: oyaml
Provides-Extra: deployment
Requires-Dist: build ; extra == 'deployment'
Requires-Dist: twine ; extra == 'deployment'
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: presentation
Requires-Dist: matplotlib ; extra == 'presentation'
Requires-Dist: jinja2 ; extra == 'presentation'

====
ocdb
====

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10697496.svg
   :target: https://doi.org/10.5281/zenodo.10697496
   :align: right

*Optical constants for elements and various materials in the EUV and VUV wavelengths.*

Welcome! This is ocdb, a **Python package** for easily accessing the X-ray/EUV/VUV **scattering and absorption data** contained in the `Optical Constants Database (OCDB) <https://www.ocdb.ptb.de/>`_ provided by the German National Metrology Institute, the `Physikalisch-Technische Bundesanstalt, PTB <https://www.ptb.de/>`_.


Features
========

A list of (planned) features:

* Access to X-ray/EUV/VUV scattering and absorption coefficients (*n* and *k*)

* Interface compatible to the `periodictable Python package <https://pypi.org/project/periodictable/>`_

* Provides data *and* uncertainties

* FAIR and linked data: citable, reliable, and reproducible

* Offline access: data contained in package

* Community-driven: easy to contribute


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 ocdb package on your computer (sensibly within a Python virtual environment), open a terminal (activate your virtual environment), and type in the following::

    pip install ocdb


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.
