From bc6e49a6864fd0f1cdc2d499462db52df8431ba4 Mon Sep 17 00:00:00 2001 From: Matthew Newville Date: Tue, 10 Oct 2023 14:16:31 -0500 Subject: [PATCH] doc tweaks --- doc/index.rst | 14 ++++++++------ doc/installation.rst | 7 +++---- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 576d392..7d803fd 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,7 +15,8 @@ file can be used directly with SQLite :cite:`sqlite` using standard SQL, or from the many programming language that support SQLite. Some of the components of the database hold arrays of numbers which are stored in the database as JSON-encoded strings, and will need to be unpacked to be used. -A Python module providing such an interface is provided here. + +A Python module providing an interface to this database is also provided here. The project began with the data from the compilation of basic atomic properties and X-ray absorption edge energies, emission energies, and @@ -34,13 +35,14 @@ 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 is **9.1**, and the version of the Python +The current version of the XrayDB database is **9.1**, and the version of the Python module is |release|. See Also: - * `XrayDB Web App (CARS, U Chicago)`_ and `XrayDB Web App - (xrayabsorption.org)`_ are interactive web applications to browse the - data in this database and make plots of X-ray attenuation, scattering - factors, mirror reflectivity, and more. + * `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. * Printable Poster-sized :ref:`periodic_tables`. diff --git a/doc/installation.rst b/doc/installation.rst index f1719b7..35a0a0e 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -6,12 +6,11 @@ Installation .. _pytest: https://pytest.org/ The X-ray database is held in the SQLite3 file ``xraydb.sqlite``. If you -are looking for direct use with SQLite, you can download this from +are looking for direct use with SQLite, you can download this from here: `xraydb.sqlite`_. -If you want to use XrayDB from Python, install the XrayDB Python module -(which includes the sqlite database), with:: +To install the XrayDB Python module (which includes the sqlite database), use:: pip install xraydb @@ -19,7 +18,7 @@ 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`. -.. Note:: The Python module supports Python 3.5 and above. +.. Note:: The Python module supports Python 3.8 and above. Development Version