Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
newville committed Jan 4, 2025
1 parent 9d2f830 commit 495eaa7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 2 deletions.
2 changes: 1 addition & 1 deletion doc/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ the `rocking_` quantities are estimated as the convolution of the intensity
with itself, to simulate an angular scan of one crystal with respect
to the other, as is often done with double-crystal monochromators.
`rocking_theta_fwhm` and `rocking_energy_fwhm` will be the FWHM of
this curve in angle and energy, and will typiccally be ~1.5x the
this curve in angle and energy, and will typically be ~1.5x the
Darwin widths in `theta_width` and `energy_width`, respectively.

All of the nd-arrays will be the same size, so that plots of
Expand Down
1 change: 0 additions & 1 deletion doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ X-ray DB: X-ray Reference Data in SQLite
.. _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 (xrayabsorption.org): https://xraydb.xrayabsorption.org/
.. _XrayDB Web App (seescience.org): https://xraydb.seescience.org/
.. _XrayDB Web App (CARS/APS): https://millenia.cars.aps.anl.gov/xraydb

XrayDB provides atomic data, characteristic X-ray energies, and X-ray cross
Expand Down
11 changes: 11 additions & 0 deletions doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,17 @@ For any release or any master branch from the git repository, running
``pytest`` should run all of these tests to completion without errors or
failures.


Citing this work
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To cite this work, please use https://zenodo.org/records/13924221

.. raw:: html

<span class="__dimensions_badge_embed__" data-doi="10.5281/zenodo.13924221"></span>
<script async src="https://badge.dimensions.ai/badge.js" charset="utf-8"></script>

Copyright, Licensing, and Re-distribution
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit 495eaa7

Please sign in to comment.