Skip to content

Commit f11289f

Browse files
committed
tutorial page
1 parent e2b8cb0 commit f11289f

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/source/tutorial.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
.. _tutorial:
2+
3+
Tutorial
4+
########
5+
6+
Input files:
7+
8+
:download:`test data <diffpy.fourigui/tests/testdata/gofr_.h5>` containing h5 files
9+
10+
Procedure:
11+
12+
1. After installation, open a terminal and type ``fourigui`` to start the program.
13+
14+
2. In ``filename``, input the file path to ``gofr_.h5`` and click load.
15+
16+
3. Select which axis you want to view (0, 1, or 2) and use the slider to explore slices of reciprocal space images.
17+
18+
4. Alter the colorbar range and click ``set range`` to create desired contrast.
19+
20+
5. The options directly below the image will allow you to save or move the plot to your liking.
21+
22+
6. Under ``Space Selection``, switch between real and reciprocal space to visualize the differences.
23+
24+
7. ``qmin`` and ``qmax`` can be changed to set your cutoff values. Click ``new cuttoff`` to set the values.
25+
26+
8. Set your animation frame rate and click ``animation`` to create an animation through the slider.

0 commit comments

Comments
 (0)