Skip to main content

A Python package for the quantitative analysis of the interaction of energetic x-rays with matter. This package is named after one of the discoverers of X-rays, Wilhelm Rontgen.

Project description

docs

Documentation Status

build status

Build Status Black linting Test coverage on codecov

package

PyPI Package latest release PyPI Package monthly downloads PyPI Wheel

https://raw.githubusercontent.com/ehsteve/roentgen/main/docs/logo/roentgen_logo.svg

A Python package for the quantitative analysis of the interaction of energetic x-rays with matter. This package is named after one of the discoverers of X-rays, Wilhelm Röntgen.

Installation

pip install roentgen

This project makes use of Poetry for dependency management. To install this project for development, clone the repository and then run the following command inside the package directory

poetry install --with dev,docs,gui

Documentation

http://roentgen.readthedocs.io/en/stable/

GUI

This package provides a gui interface to quickly investigate the absorption and transmission of x-rays through different materials. It is based on bokeh. To run it locally use the following command

bokeh serve --show <roengten_directory>/gui

Data Sources

This package includes on a number of data files which were translated and imported from a few key sources. The package developers would like to thank the following data providers

  • The U.S National Institute of Standards and Technology (NIST)

  • The Center for X-ray Optics and Advanced Light Source at the Lawrence Berkeley National Laboratory

For more information see the README in data directory.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Have a look at the great guide from the sunpy project which provides advice for new contributors.

Code of Conduct

When you are interacting with members of this community, you are asked to follow the SunPy Code of Conduct.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roentgen-2.0.2.tar.gz (116.1 kB view hashes)

Uploaded Source

Built Distribution

roentgen-2.0.2-py3-none-any.whl (183.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page