From 01ee9e0ade790adc7c69b7ad5e3d091e73631883 Mon Sep 17 00:00:00 2001 From: Matthew Newville Date: Sun, 5 Nov 2023 11:39:29 -0600 Subject: [PATCH] doc updates for 4.5.2 --- doc/dbschema.rst | 2 +- doc/examples.rst | 24 +++++++++++++----------- doc/index.rst | 13 ++++++------- doc/installation.rst | 4 ++-- doc/periodictable.rst | 3 +-- 5 files changed, 23 insertions(+), 23 deletions(-) diff --git a/doc/dbschema.rst b/doc/dbschema.rst index 660133b..dc0b645 100644 --- a/doc/dbschema.rst +++ b/doc/dbschema.rst @@ -434,7 +434,7 @@ The `Compton_energies` table holds data for median (90 deg scattering) and mean values of the energies of Compton scattered X-rays, and the mean values of the Compton-scattered electrons as a function of incident X-ray energy. There is only 1 row in this table, with all columns being json-encoded arrays of floats. -These values should be finely-speced enough for linear interpolation +These values should be finely-spaced enough for linear interpolation .. index:: DB Table of Compton Energies diff --git a/doc/examples.rst b/doc/examples.rst index ed89f16..36564ef 100644 --- a/doc/examples.rst +++ b/doc/examples.rst @@ -3,18 +3,20 @@ Example Calculations of X-ray properties of materials ========================================================= -.. _XrayDB Web App (beta!): https://millenia.cars.aps.anl.gov/xraydb +.. _XrayDB Web App (xrayabsorption.org): https://xraydb.xrayabsorption.org/ .. module:: xraydb :noindex: -Here, a few detailed examples of using the `xraydb.sqlite` to calculate the -X-ray properties of materials are shown. These all use the functions in -the python `xraydb` module, which is describe in more detail in the next -chapter, :ref:`python_api`. The examples will explore some aspects of -X-ray physics, but will not give a complete tutorial on the concepts here. -For reference see :cite:`AlsNielson_McMorrow2011` for example. Some of -these calculations are also available at `XrayDB Web App (beta!)`_. +A few detailed examples of using the `xraydb.sqlite` to calculate the X-ray +properties of materials are presented here. These all use the functions in the +python `xraydb` module, which is describe in more detail in the next chapter, +:ref:`python_api`. The examples will explore some aspects of X-ray physics, +but will not give a complete tutorial on the concepts here. For a good +reference on X-ray physics, see :cite:`AlsNielson_McMorrow2011`. + +Many of these calculations are also available at `XrayDB Web App (xrayabsorption.org)`_. + X-ray attenuation by elements @@ -297,9 +299,9 @@ enough to prevent any recombination of charged particles. For a given gas at an incident X-ray energy :math:`E`, we calculate the total, photo-electric, incoherent (Compton), and coherent (Rayleigh) values of :math:`\mu`. If more than one gas is used, the weighted sum is calculated, so -that we have :math:`\mu_{\rm total}`, :math:`\mu_{\rm photo}`, :math:`\mu_{\rm -incoh}`, and :math:`\mu_{\rm coh}` for the gas in the chamber (or diode -material). +that we have :math:`\mu_{\rm total}`, :math:`\mu_{\rm photo}`, +:math:`\mu_{\rm incoh}`, and :math:`\mu_{\rm coh}` for the gas in the +chamber or diode material. The flux transmitted out of the chamber is diff --git a/doc/index.rst b/doc/index.rst index 7d803fd..029e50e 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,8 +6,8 @@ X-ray DB: X-ray Reference Data in SQLite .. _XrayDB Github Page: https://github.com/xraypy/XrayDB .. _FFAST webpage: https://www.nist.gov/pml/data/ffast/index.cfm .. _PDF Version of this documentation: https://xraypy.github.io/XrayDB/xraydb.pdf -.. _XrayDB Web App (CARS, U Chicago): https://millenia.cars.aps.anl.gov/xraydb .. _XrayDB Web App (xrayabsorption.org): https://xraydb.xrayabsorption.org/ +.. _XrayDB Web App (CARS, U Chicago): https://millenia.cars.aps.anl.gov/xraydb XrayDB provides atomic data, characteristic X-ray energies, and X-ray cross sections for the elements in an SQLite3 database, ``xraydb.sqlite``. This @@ -35,16 +35,15 @@ data for cross-sections are typically most reliable between about 250 eV to about 250,000 eV. Elements from Z=1 to 92 are supported, with some data are included for elements between Z=93 and Z=98. -The current version of the XrayDB database is **9.1**, and the version of the Python -module is |release|. See Also: +The current version of the XrayDB database is **9.1**, and the version of the +Python module is |release|. A few useful resources using this library include: * `XrayDB Web App (xrayabsorption.org)`_ is an interactive web applications to browse the data in this database and make plots of X-ray attenuation, - scattering factors, mirror reflectivity, and more. For each sort of data - retrieved, data tables and the python code to generate that data are also - available. + scattering factors, mirror reflectivity, and more. Data tables and python + code to generate that data are available for many of the calculations. - * Printable Poster-sized :ref:`periodic_tables`. + * :ref:`periodic_tables` for printable Poster-sized Periodic tables of X-ray energies. * `XrayDB Github Page`_ has data sources, code, development and issues. diff --git a/doc/installation.rst b/doc/installation.rst index 35a0a0e..9360f03 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -15,8 +15,8 @@ To install the XrayDB Python module (which includes the sqlite database), use:: pip install xraydb Depending on your system and Python installation, you may need -administrative privileges to install any python library. For many linux -and Mac OS X systems, you may need to use `sudo`. +administrative privileges or to use `sudo` to install to a system-installed +Python environment. .. Note:: The Python module supports Python 3.8 and above. diff --git a/doc/periodictable.rst b/doc/periodictable.rst index 6912245..772b9f4 100644 --- a/doc/periodictable.rst +++ b/doc/periodictable.rst @@ -1,4 +1,3 @@ - .. _periodic_tables: X-ray Periodic Table of the Elements @@ -43,7 +42,7 @@ Large is 127.5x61 cm (about 50x24 inches) and Medium is 91x45.5 cm (about 36x17 | `Henry Moseley`_ | `Moseley (Large)`_ | `Moseley (Medium)`_ | +----------------------+------------------------+------------------------+ -In general, these table look like this: +These periodic tables will look like this: .. image:: _images/xray_table.png :width: 75%