Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
kylechampley committed Feb 18, 2024
2 parents d757922 + 2dc0a83 commit a0e53b3
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,22 @@
# XrayPhysics
This is a C/C++ library and Python bindings with the following capabilities:
1) x-ray cross sections (energies from 1 keV to 20 MeV and elements 1-100)
2) incoherent and coherent x-ray scattering angle distributions
This is a C/C++ library with Python bindings with the following capabilities:
1) x-ray cross sections (energies from 1 keV to 20 MeV and elements 1-100) specified by chemical formula or element/compound mass fractions
2) incoherent and coherent x-ray scattering angle distributions specified by chemical formula or element/compound mass fractions
3) x-ray source spectra modeling (for any source voltage and take-off angle, and the following anode types: Cu, Mo, W, Au)
4) one- and two-material beam hardening correction algorithms (theoretically exact and polynomial-based)
5) Calculation of the LLNL-defined effective atomic number; For more information see [here](https://ieeexplore.ieee.org/document/8638824)
6) dual energy decomposition algorithms (and SIRZ if used in conjuction with [LEAP](https://github.com/LLNL/LEAP))

And here are the features we are working on for the next relase:
1) multi-material beam hardening correction algorithms for any number of materials
There are very few dependencies and we don't use any specialized data structures, making it very easy to incorporate with other software packages. The cross section tables are hard-coded into C++ arrays, so queries of the database are instant.

![The x-ray source models are at least as accurate as TASMICS and much more flexible.](https://github.com/kylechampley/XrayPhysics/blob/main/comparisonWithTASMICS.png)

The x-ray source models are at least as accurate as TASMICS and much more flexible.
The x-ray source models are at least as accurate as TASMICS and much more flexible. The cross section tables are based on [EPDL97.](https://www-nds.iaea.org/epdl97/)


## Installation and Usage

Installation and usage information is posted on the wiki page here: https://github.com/kylechampley/XrayPhysics/wiki
Installation and usage information is posted on the [wiki page](https://github.com/kylechampley/XrayPhysics/wiki)

Designed to be used in conjuction with (but is not required) [LEAP](https://github.com/LLNL/LEAP)

Expand Down

0 comments on commit a0e53b3

Please sign in to comment.