Skip to content

Commit

Permalink
WIP: initial XRD1D doc
Browse files Browse the repository at this point in the history
  • Loading branch information
newville committed Dec 23, 2023
1 parent 8e1f3be commit 115c10f
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 18 deletions.
1 change: 1 addition & 0 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ Table of Contents
guis.rst
xasviewer.rst
wxmap_viewer.rst
xrd1d_viewer.rst
qtrixs.rst
python.rst
larchlang.rst
Expand Down
14 changes: 6 additions & 8 deletions doc/wxmap_viewer.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
.. _mapviewer_app:

==========================
GSECARS Mapviewr
XRFMap Viewr
==========================

.. _wxmplot: https://newville.github.io/wxmplot
.. _matplotlib: https://matplotlib.org/


The GSECARS Mapviewer is one of the main GUI applications of Larch,
The GSECARS XRFMap Viewer is one of the main GUI applications of Larch,
allowing users to read and display HDF5 files containing X-ray fluorescence
maps from synchrotron X-ray microprobes. The program plays the dual role
of displaying existing X-ray microprobe maps in HDF5 format and assembling
those HDF5 X-ray microprobe map files from the raw data as collected APS
beamline 13-ID-E or other microprobes using the same Epics scanning
software used there.
maps from synchrotron X-ray microprobes. The program plays the dual role of
displaying existing X-ray microprobe maps in HDF5 format and assembling those
HDF5 X-ray microprobe map files from the raw data as collected APS beamline
13-ID-E or other microprobes using the same Epics scanning software used there.



Expand Down
20 changes: 10 additions & 10 deletions doc/xasviewer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
Larix (was XAS Viewer)
===========================

The Larix Application gives a graphical user interface (GUI) for the
The `Larix` Application gives a graphical user interface (GUI) for the
visualization and analyis of X-ray absorption spectroscopy (XAS) data, both
XANES and EXAFS. It is deliberately patterned after the Demeter Package
(Athena and Artemis programs), and shares many concepts and presentation ideas
with these progrqms. As a GUI Program, Larix should seem very "Athena-like"
though of course there will be several differences. We hope that many of
these differences will be "improvements". By using Larch for all of its
analysis steps, Larix not only provides interactive data visualization,
exploration, and analysis of XAS data, but also records those steps as Larch /
Python commands that can be saved and reproduced outside of the GUI, say to
enable batch processing of large volumes of data.
XANES and EXAFS. It is deliberately patterned after the Demeter Package (Athena
and Artemis programs), and shares many concepts and presentation ideas with
these progrqms. As a GUI Program, Larix should seem very "Athena-like" though
of course there will be several differences. We hope that many of these
differences will be "improvements". By using Larch for all of its analysis
steps, Larix not only provides interactive data visualization, exploration, and
analysis of XAS data, but also records those steps as Larch / Python commands
that can be saved and reproduced outside of the GUI, say to enable batch
processing of large volumes of data.

Larix is still in active development with new features driving much of the
development and releases of Larch version for the past few years. At this
Expand Down
21 changes: 21 additions & 0 deletions doc/xrd1d_viewer.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _larchxrd1d-chapter:

.. _larchxrd1d_app:

Larch XRD1D Viewer
==========================


The `Larch XRD1D` application allows simple viewing and manipulation of
1-dimensional XRD patterns of diffracted intensity as a function of scattering
wavenumber or angle: :math:`I(q)`, :math:`I(2\theta)`. The application allows

1. reading and comparison of multiple XRD patterns.
2. fitting and subtracting a background from an XRD pattern.




.. image:: _images/xrd1d_main_with_tiff.png
:target: _images/xrd1d_main_with_tiff.png
:width: 70%

0 comments on commit 115c10f

Please sign in to comment.