Skip to content

Commit f2145c6

Browse files
committed
work on universal tree items
1 parent 5f9520d commit f2145c6

File tree

8 files changed

+200
-159
lines changed

8 files changed

+200
-159
lines changed

.github/workflows/test_builddocsite.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
# Also the tutorials.html file and the */data/index.html files are
88
# created by running scripts/makeGitTutorial
99

10-
# this is a test version that creates draft help pages from the MDhelp directory
10+
# this is a development version that creates draft help pages from the MDhelp directory
1111

1212
name: test MD help w/build GSAS-II web site
1313

@@ -97,7 +97,7 @@ jobs:
9797
mv _gsas2/GSASII/help ./help
9898
- name: Get rid of the rest of the GSAS-II files & other stuff not needed on web
9999
run: |
100-
rm -rf _gsas2 webdocs scripts MDtutorials
100+
rm -rf _gsas2 webdocs scripts MDtutorials MDhelp
101101
102102
- name: Upload artifact # creates zip file with website contents
103103
uses: actions/upload-pages-artifact@v3

MDhelp/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
site
2+
pyproject.toml
3+
uv.lock

MDhelp/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,12 @@ additional links that need to be added:
1313
60 docs/applicationwindow.md
1414
191 docs/mainmenu.md
1515
95 docs/others.md
16+
10 docs/datatree.md
17+
165 docs/commontreeitems.md
1618

1719
These files have had only minor editing. A few need to be broken up:
1820

19-
170 docs/cluster.md
20-
157 docs/datatree.md
21+
170 docs/cluster.md
2122
445 docs/histgramtree.md
2223
154 docs/image.md
2324
59 docs/pairdistribution.md

MDhelp/docs/applicationwindow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The leftmost entries in the GSAS-II menu provide access to many features of GSAS
1717
Different information is displayed in the Data Editing Window, depending on which section of the [data tree](#Data_tree) is selected. For example, clicking on the "Notebook" entry of the data tree brings up the [Notebook editing window](#TBD), as documented elsewhere.
1818

1919
<a name="Plots"></a>
20-
## GSAS-II Plots Window
20+
## GSAS-II Graphics Window
2121

2222
This window presents all the graphical material as a multipage tabbed set of plots utilizing the matplotlib python package. Each page containing a graph or plot has a tool bar with these controls:
2323

MDhelp/docs/commontreeitems.md

Lines changed: 183 additions & 0 deletions
Large diffs are not rendered by default.

MDhelp/docs/datatree.md

Lines changed: 5 additions & 152 deletions
Large diffs are not rendered by default.

MDhelp/docs/phase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ Actions to reposition the rigid body in either mode are:
357357

358358
This tab is used to control settings used for a texture study of a material. This type of characterization usually requires diffraction data recorded with multiple detector orientations (the number of orientations will depend on sample and material symmetry). Do not confuse this with applying a [preferred orientation correction](./phase.md#preferred_orientation) (found in the ["Data" tab](#data)) in a structural study. The sample orientation relative to the detector axes is specified here and the detector orientation is specified for each histogram as goniometer omega, chi, phi and azimuth values (details below). These values must be specified.
359359

360-
Texture analysis using GSAS-II employs spherical harmonics modeling, as described by Bunge, "Texture Analysis in Materials Science" (1982), and implemented by Von Dreele, J. Appl. Cryst., 30, 517-525 (1997) in GSAS. The even part of the orientation distribution function (ODF) via the general axis equatio
360+
Texture analysis using GSAS-II employs spherical harmonics modeling, as described by Bunge, "Texture Analysis in Materials Science" (1982), and implemented by Von Dreele, J. Appl. Cryst., 30, 517-525 (1997) in GSAS. The even part of the orientation distribution function (ODF) via the general axis equation
361361

362362
$$
363363
A(x,y) = 1 + \sum_{L=2}^{N_L}{\frac{4\pi}{2L+1}} \sum_{m=-L}^{L} \sum_{n=-L}^{L} C_L^{mn} k_L^m(y) k_L^n(h)

MDhelp/mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ nav:
66
- GUI components: applicationwindow.md
77
- Main menu: mainmenu.md
88
- Data tree items:
9-
- Standard items: datatree.md
9+
- Data tree overview: datatree.md
10+
- Universal items: commontreeitems.md
1011
- Powder (PWDR): histgramtree.md
1112
- Images: image.md
1213
- PDF: pairdistribution.md
@@ -45,6 +46,7 @@ markdown_extensions:
4546

4647
extra_javascript:
4748
- https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
49+
# - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js # MathJax library from CDN
4850

4951
#local build settings from https://www.mkdocs.org/user-guide/deploying-your-docs/#local-files
5052

0 commit comments

Comments
 (0)