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

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.1.tar.gz (116.0 kB view details)

Uploaded Source

Built Distribution

roentgen-2.0.1-py3-none-any.whl (183.5 kB view details)

Uploaded Python 3

File details

Details for the file roentgen-2.0.1.tar.gz.

File metadata

  • Download URL: roentgen-2.0.1.tar.gz
  • Upload date:
  • Size: 116.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.12 Darwin/22.2.0

File hashes

Hashes for roentgen-2.0.1.tar.gz
Algorithm Hash digest
SHA256 ccfc6668539b30758c323f479e1d2ff6ebaa4d9a63d1402e858b5fb512946081
MD5 3ff3d665df31ecbea0cd7f1f1f777020
BLAKE2b-256 7a094222c7da067a6ed10593b3bac2783d506c29eec0b4f33ce53734d049b4ea

See more details on using hashes here.

Provenance

File details

Details for the file roentgen-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: roentgen-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 183.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.1 CPython/3.9.12 Darwin/22.2.0

File hashes

Hashes for roentgen-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e680504e8a2cd6239ed49b99a31efdaf6dbcbebbd91bb1cee6dbe5de6e41922f
MD5 5d33dbe9f6b4cedf002d78ec45ddde4b
BLAKE2b-256 f592eae879cf22de291bd65195b3a4c006872754d6513f1dc7e676defe73015f

See more details on using hashes here.

Provenance

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