diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst new file mode 100644 index 0000000..251a0a8 --- /dev/null +++ b/doc/source/tutorial.rst @@ -0,0 +1,26 @@ +.. _tutorial: + +Tutorial +######## + +Input files: + +**download test data ``gofr_.h5`` at https://github.com/diffpy/diffpy.fourigui/tree/main/tests/testdata** + +Procedure: + +1. After installation, open a terminal and type ``fourigui`` to start the program. + +2. In ``filename``, input the file path to ``gofr_.h5`` and click load. + +3. Select which axis you want to view (0, 1, or 2) and use the slider to explore slices of reciprocal space images. + +4. Alter the colorbar range and click ``set range`` to create desired contrast. + +5. The options directly below the image will allow you to save or move the plot to your liking. + +6. Under ``Space Selection``, switch between real and reciprocal space to visualize the differences. + +7. ``qmin`` and ``qmax`` can be changed to set your cutoff values. Click ``new cuttoff`` to set the values. + +8. Set your animation frame rate and click ``animation`` to create an animation through the slider. diff --git a/news/tutorial.rst b/news/tutorial.rst new file mode 100644 index 0000000..1111a5d --- /dev/null +++ b/news/tutorial.rst @@ -0,0 +1,23 @@ +**Added:** + +* tutorial added to documentation + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* added [project.scripts] to pyproject.toml + +**Security:** + +* diff --git a/pyproject.toml b/pyproject.toml index 6ef9d17..d84d5b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,7 +14,7 @@ maintainers = [ description = "Tool for visualizing 3D diffraction and PDF Images." keywords = ['diffraction', 'pdf', 'pair distribution function', 'gui'] readme = "README.rst" -requires-python = ">=3.10, <3.13" +requires-python = ">=3.10, <3.14" classifiers = [ 'Development Status :: 5 - Production/Stable', 'Environment :: Console', @@ -32,6 +32,9 @@ classifiers = [ 'Topic :: Scientific/Engineering :: Chemistry', ] +[project.scripts] +fourigui = "diffpy.fourigui.fourigui:main" + [project.urls] Homepage = "https://github.com/diffpy/diffpy.fourigui/" Issues = "https://github.com/diffpy/diffpy.fourigui/issues/"