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

Uploaded Source

Built Distribution

roentgen-2.1.0-py3-none-any.whl (184.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: roentgen-2.1.0.tar.gz
  • Upload date:
  • Size: 116.7 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.1.0.tar.gz
Algorithm Hash digest
SHA256 b869f6e5af64ccf67317cf7876b0bc76b918ed3aec3ebb75435ed2f4f8b5cbb3
MD5 2e8c454b13df15b47bc7c269f1c058b6
BLAKE2b-256 2b4a7e7cce6ab2a42c11de78ab808c827adef59f30958887c8df59db20985029

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: roentgen-2.1.0-py3-none-any.whl
  • Upload date:
  • Size: 184.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ecbfd7b57915e224fd172c997dee7ab078a2bd2d445f45b6c4c657d7bd1c0cfc
MD5 0ad030bbf9d53462900dbb1031aee2b5
BLAKE2b-256 57fa966eee5640579cafba511efae2a84e248b3cb03509e49c404f958c000117

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