liquid-structure-step 2026.10.16__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (55) hide show
  1. liquid_structure_step-2026.10.16/AUTHORS.rst +5 -0
  2. liquid_structure_step-2026.10.16/CONTRIBUTING.rst +113 -0
  3. liquid_structure_step-2026.10.16/HISTORY.rst +14 -0
  4. liquid_structure_step-2026.10.16/LICENSE +31 -0
  5. liquid_structure_step-2026.10.16/MANIFEST.in +14 -0
  6. liquid_structure_step-2026.10.16/PKG-INFO +124 -0
  7. liquid_structure_step-2026.10.16/README.rst +61 -0
  8. liquid_structure_step-2026.10.16/docs/Makefile +177 -0
  9. liquid_structure_step-2026.10.16/docs/_static/SEAMM Inverted 288x181.png +0 -0
  10. liquid_structure_step-2026.10.16/docs/_static/SEAMM logo.png +0 -0
  11. liquid_structure_step-2026.10.16/docs/_static/molssi_main_logo.png +0 -0
  12. liquid_structure_step-2026.10.16/docs/_static/molssi_main_logo_inverted_white.png +0 -0
  13. liquid_structure_step-2026.10.16/docs/_static/molssi_square.png +0 -0
  14. liquid_structure_step-2026.10.16/docs/_static/nsf.png +0 -0
  15. liquid_structure_step-2026.10.16/docs/api/index.rst +17 -0
  16. liquid_structure_step-2026.10.16/docs/authors.rst +1 -0
  17. liquid_structure_step-2026.10.16/docs/conf.py +306 -0
  18. liquid_structure_step-2026.10.16/docs/developer_guide/campaigns/2026-10-16/index.rst +36 -0
  19. liquid_structure_step-2026.10.16/docs/developer_guide/campaigns/index.rst +17 -0
  20. liquid_structure_step-2026.10.16/docs/developer_guide/contributing.rst +1 -0
  21. liquid_structure_step-2026.10.16/docs/developer_guide/index.rst +28 -0
  22. liquid_structure_step-2026.10.16/docs/developer_guide/installation.rst +54 -0
  23. liquid_structure_step-2026.10.16/docs/developer_guide/usage.rst +7 -0
  24. liquid_structure_step-2026.10.16/docs/getting_started/index.rst +31 -0
  25. liquid_structure_step-2026.10.16/docs/history.rst +1 -0
  26. liquid_structure_step-2026.10.16/docs/index.rst +72 -0
  27. liquid_structure_step-2026.10.16/docs/make.bat +242 -0
  28. liquid_structure_step-2026.10.16/docs/user_guide/index.rst +122 -0
  29. liquid_structure_step-2026.10.16/liquid_structure_step/__init__.py +26 -0
  30. liquid_structure_step-2026.10.16/liquid_structure_step/_version.py +21 -0
  31. liquid_structure_step-2026.10.16/liquid_structure_step/analysis.py +667 -0
  32. liquid_structure_step-2026.10.16/liquid_structure_step/data/properties.csv +3 -0
  33. liquid_structure_step-2026.10.16/liquid_structure_step/data/references.bib +61 -0
  34. liquid_structure_step-2026.10.16/liquid_structure_step/liquid_structure.py +1038 -0
  35. liquid_structure_step-2026.10.16/liquid_structure_step/liquid_structure_parameters.py +218 -0
  36. liquid_structure_step-2026.10.16/liquid_structure_step/liquid_structure_step.py +98 -0
  37. liquid_structure_step-2026.10.16/liquid_structure_step/metadata.py +170 -0
  38. liquid_structure_step-2026.10.16/liquid_structure_step/tk_liquid_structure.py +254 -0
  39. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/PKG-INFO +124 -0
  40. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/SOURCES.txt +54 -0
  41. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/dependency_links.txt +1 -0
  42. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/entry_points.txt +5 -0
  43. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/requires.txt +7 -0
  44. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/top_level.txt +1 -0
  45. liquid_structure_step-2026.10.16/liquid_structure_step.egg-info/zip-safe +1 -0
  46. liquid_structure_step-2026.10.16/requirements.txt +7 -0
  47. liquid_structure_step-2026.10.16/requirements_dev.txt +10 -0
  48. liquid_structure_step-2026.10.16/requirements_install.txt +4 -0
  49. liquid_structure_step-2026.10.16/setup.cfg +27 -0
  50. liquid_structure_step-2026.10.16/setup.py +89 -0
  51. liquid_structure_step-2026.10.16/tests/__init__.py +3 -0
  52. liquid_structure_step-2026.10.16/tests/test_analysis.py +271 -0
  53. liquid_structure_step-2026.10.16/tests/test_gui.py +65 -0
  54. liquid_structure_step-2026.10.16/tests/test_liquid_structure_step.py +16 -0
  55. liquid_structure_step-2026.10.16/versioneer.py +1883 -0
@@ -0,0 +1,5 @@
1
+ Development Team
2
+ ----------------
3
+
4
+ * Paul Saxe <psaxe@molssi.org> (Lead)
5
+ * Why don't you join the team? Become a contributor!
@@ -0,0 +1,113 @@
1
+ .. highlight:: shell
2
+
3
+ ============
4
+ Contributing
5
+ ============
6
+
7
+ Contributions are welcome, and they are greatly appreciated! Every
8
+ little bit helps, and credit will always be given.
9
+
10
+ You can contribute in many ways:
11
+
12
+ Types of Contributions
13
+ ----------------------
14
+
15
+ Report Bugs
16
+ ~~~~~~~~~~~
17
+
18
+ Report bugs at https://github.com/molssi-seamm/liquid_structure_step/issues.
19
+
20
+ If you are reporting a bug, please include:
21
+
22
+ * Your operating system name and version.
23
+ * Any details about your local setup that might be helpful in troubleshooting.
24
+ * Detailed steps to reproduce the bug.
25
+
26
+ Fix Bugs
27
+ ~~~~~~~~
28
+
29
+ Look through the GitHub issues for bugs. Anything tagged with "bug"
30
+ and "help wanted" is open to whoever wants to implement it.
31
+
32
+ Implement Features
33
+ ~~~~~~~~~~~~~~~~~~
34
+
35
+ Look through the GitHub issues for features. Anything tagged with "enhancement"
36
+ and "help wanted" is open to whoever wants to implement it.
37
+
38
+ Write Documentation
39
+ ~~~~~~~~~~~~~~~~~~~
40
+
41
+ Liquid Structure Step could always use more documentation, whether as part of the
42
+ official Liquid Structure Step docs, in docstrings, or even on the web in blog posts,
43
+ articles, and such.
44
+
45
+ Submit Feedback
46
+ ~~~~~~~~~~~~~~~
47
+
48
+ The best way to send feedback is to file an issue at https://github.com/molssi-seamm/liquid_structure_step/issues.
49
+
50
+ If you are proposing a feature:
51
+
52
+ * Explain in detail how it would work.
53
+ * Keep the scope as narrow as possible, to make it easier to implement.
54
+ * Remember that this is a volunteer-driven project, and that contributions
55
+ are welcome :)
56
+
57
+ Get Started!
58
+ ------------
59
+
60
+ Ready to contribute? Here's how to set up `liquid_structure_step` for local development.
61
+
62
+ 1. Fork the `liquid_structure_step` repo on GitHub.
63
+ 2. Clone your fork locally::
64
+
65
+ $ git clone git@github.com:your_name_here/liquid_structure_step.git
66
+
67
+ 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68
+
69
+ $ mkvirtualenv liquid_structure_step
70
+ $ cd liquid_structure_step/
71
+ $ python setup.py develop
72
+
73
+ 4. Create a branch for local development::
74
+
75
+ $ git checkout -b name-of-your-bugfix-or-feature
76
+
77
+ Now you can make your changes locally.
78
+
79
+ 5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
80
+
81
+ $ flake8 liquid_structure_step tests
82
+ $ python setup.py test or py.test
83
+ $ tox
84
+
85
+ To get flake8 and tox, just pip install them into your virtualenv.
86
+
87
+ 6. Commit your changes and push your branch to GitHub::
88
+
89
+ $ git add .
90
+ $ git commit -m "Your detailed description of your changes."
91
+ $ git push origin name-of-your-bugfix-or-feature
92
+
93
+ 7. Submit a pull request through the GitHub website.
94
+
95
+ Pull Request Guidelines
96
+ -----------------------
97
+
98
+ Before you submit a pull request, check that it meets these guidelines:
99
+
100
+ 1. The pull request should include tests.
101
+ 2. If the pull request adds functionality, the docs should be updated. Put
102
+ your new functionality into a function with a docstring, and add the
103
+ feature to the list in README.rst.
104
+ 3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check
105
+ https://travis-ci.org/molssi-seamm/liquid_structure_step/pull_requests
106
+ and make sure that the tests pass for all supported Python versions.
107
+
108
+ Tips
109
+ ----
110
+
111
+ To run a subset of tests::
112
+
113
+ $ py.test tests.test_liquid_structure_step
@@ -0,0 +1,14 @@
1
+ =======
2
+ History
3
+ =======
4
+
5
+ 2026.10.16 -- First release: the structure of liquids and solutions
6
+ * Radial distribution functions of pairs of sites, with errors, their first peaks
7
+ and minima, and coordination numbers, with fixed cutoffs where the minima
8
+ mislead.
9
+ * The pairing of ions: each cation free, in a solvent-separated (SSIP) or contact
10
+ (CIP) pair, or in an aggregate (AGG).
11
+ * The solvation shells of solutes: the coordination number of each solvent, the
12
+ most common shells, pairing, and residence times.
13
+ * Runs its own MD or analyzes the MD earlier in the flowchart, and checks before
14
+ the job runs that the MD samples the positions often enough.
@@ -0,0 +1,31 @@
1
+
2
+ BSD 3-Clause License
3
+
4
+ Copyright (c) 2026, Paul Saxe
5
+ All rights reserved.
6
+
7
+ Redistribution and use in source and binary forms, with or without
8
+ modification, are permitted provided that the following conditions are met:
9
+
10
+ 1. Redistributions of source code must retain the above copyright notice, this
11
+ list of conditions and the following disclaimer.
12
+
13
+ 2. Redistributions in binary form must reproduce the above copyright notice,
14
+ this list of conditions and the following disclaimer in the documentation
15
+ and/or other materials provided with the distribution.
16
+
17
+ 3. Neither the name of the copyright holder nor the names of its
18
+ contributors may be used to endorse or promote products derived from
19
+ this software without specific prior written permission.
20
+
21
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31
+
@@ -0,0 +1,14 @@
1
+ include AUTHORS.rst
2
+ include CONTRIBUTING.rst
3
+ include HISTORY.rst
4
+ include LICENSE
5
+ include README.rst
6
+ include requirements*
7
+ include versioneer.py
8
+
9
+ recursive-include liquid_structure_step/data *
10
+ recursive-include tests *
11
+ recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
12
+
13
+ recursive-exclude * __pycache__
14
+ recursive-exclude * *.py[co]
@@ -0,0 +1,124 @@
1
+ Metadata-Version: 2.4
2
+ Name: liquid_structure_step
3
+ Version: 2026.10.16
4
+ Summary: A SEAMM plug-in for Liquid Structure
5
+ Home-page: https://github.com/molssi-seamm/liquid_structure_step
6
+ Author: Paul Saxe
7
+ Author-email: psaxe@molssi.org
8
+ License: BSD-3-Clause
9
+ Keywords: SEAMM,SEAMMplugin,flowchart
10
+ Platform: Linux
11
+ Platform: Mac OS-X
12
+ Platform: Unix
13
+ Platform: Windows
14
+ Classifier: Environment :: Plugins
15
+ Classifier: Development Status :: 2 - Pre-Alpha
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Topic :: Scientific/Engineering :: Chemistry
18
+ Classifier: Topic :: Scientific/Engineering :: Physics
19
+ Classifier: License :: OSI Approved :: BSD License
20
+ Classifier: Natural Language :: English
21
+ Classifier: Programming Language :: Python :: 3 :: Only
22
+ Classifier: Programming Language :: Python :: 3.12
23
+ Requires-Python: >=3.12
24
+ Description-Content-Type: text/x-rst
25
+ License-File: LICENSE
26
+ License-File: AUTHORS.rst
27
+ Requires-Dist: MDAnalysis>=2.8
28
+ Requires-Dist: numpy
29
+ Requires-Dist: seamm
30
+ Requires-Dist: seamm-md-analysis[structure]>=2026.10.15.2
31
+ Requires-Dist: seamm-util
32
+ Requires-Dist: seamm-widgets
33
+ Requires-Dist: tabulate
34
+ Dynamic: author
35
+ Dynamic: author-email
36
+ Dynamic: classifier
37
+ Dynamic: description
38
+ Dynamic: description-content-type
39
+ Dynamic: home-page
40
+ Dynamic: keywords
41
+ Dynamic: license
42
+ Dynamic: license-file
43
+ Dynamic: platform
44
+ Dynamic: requires-dist
45
+ Dynamic: requires-python
46
+ Dynamic: summary
47
+
48
+ ==============================
49
+ SEAMM Liquid Structure Plug-in
50
+ ==============================
51
+
52
+ .. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/liquid_structure_step
53
+ :target: https://github.com/molssi-seamm/liquid_structure_step/pulls
54
+ :alt: GitHub pull requests
55
+
56
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/CI/badge.svg
57
+ :target: https://github.com/molssi-seamm/liquid_structure_step/actions
58
+ :alt: Build Status
59
+
60
+ .. image:: https://codecov.io/gh/molssi-seamm/liquid_structure_step/branch/master/graph/badge.svg
61
+ :target: https://codecov.io/gh/molssi-seamm/liquid_structure_step
62
+ :alt: Code Coverage
63
+
64
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/CodeQL/badge.svg
65
+ :target: https://github.com/molssi-seamm/liquid_structure_step/security/code-scanning
66
+ :alt: Code Quality
67
+
68
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/Release/badge.svg
69
+ :target: https://molssi-seamm.github.io/liquid_structure_step/index.html
70
+ :alt: Documentation Status
71
+
72
+ .. image:: https://img.shields.io/pypi/v/liquid_structure_step.svg
73
+ :target: https://pypi.python.org/pypi/liquid_structure_step
74
+ :alt: PyPi VERSION
75
+
76
+ A SEAMM plug-in for the structure of liquids and solutions from molecular dynamics:
77
+ radial distribution functions, coordination numbers, ion pairing and solvation shells.
78
+
79
+ * Free software: BSD-3-Clause
80
+ * Documentation: https://molssi-seamm.github.io/liquid_structure_step/index.html
81
+ * Code: https://github.com/molssi-seamm/liquid_structure_step
82
+
83
+ Features
84
+ --------
85
+
86
+ * Partial radial distribution functions with errors, their first peaks and minima, and
87
+ coordination numbers, with fixed cutoffs where the minima mislead.
88
+ * The pairing of ions: free, solvent-separated (SSIP), contact (CIP) and aggregated
89
+ (AGG) pairs, also for clusters.
90
+ * Solvation shells: coordination numbers per solvent, the most common shells, pairing,
91
+ and residence times.
92
+ * Runs its own MD or analyzes MD earlier in the flowchart, from SEAMM's H5MD files.
93
+
94
+ Acknowledgements
95
+ ----------------
96
+
97
+ This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
98
+ is based on the excellent Cookiecutter_.
99
+
100
+ .. _Cookiecutter: https://github.com/audreyr/cookiecutter
101
+ .. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
102
+
103
+ Developed by the Molecular Sciences Software Institute (MolSSI_),
104
+ which receives funding from the `National Science Foundation`_ under
105
+ award CHE-2136142.
106
+
107
+ .. _MolSSI: https://molssi.org
108
+ .. _`National Science Foundation`: https://www.nsf.gov
109
+
110
+
111
+ =======
112
+ History
113
+ =======
114
+
115
+ 2026.10.16 -- First release: the structure of liquids and solutions
116
+ * Radial distribution functions of pairs of sites, with errors, their first peaks
117
+ and minima, and coordination numbers, with fixed cutoffs where the minima
118
+ mislead.
119
+ * The pairing of ions: each cation free, in a solvent-separated (SSIP) or contact
120
+ (CIP) pair, or in an aggregate (AGG).
121
+ * The solvation shells of solutes: the coordination number of each solvent, the
122
+ most common shells, pairing, and residence times.
123
+ * Runs its own MD or analyzes the MD earlier in the flowchart, and checks before
124
+ the job runs that the MD samples the positions often enough.
@@ -0,0 +1,61 @@
1
+ ==============================
2
+ SEAMM Liquid Structure Plug-in
3
+ ==============================
4
+
5
+ .. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/liquid_structure_step
6
+ :target: https://github.com/molssi-seamm/liquid_structure_step/pulls
7
+ :alt: GitHub pull requests
8
+
9
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/CI/badge.svg
10
+ :target: https://github.com/molssi-seamm/liquid_structure_step/actions
11
+ :alt: Build Status
12
+
13
+ .. image:: https://codecov.io/gh/molssi-seamm/liquid_structure_step/branch/master/graph/badge.svg
14
+ :target: https://codecov.io/gh/molssi-seamm/liquid_structure_step
15
+ :alt: Code Coverage
16
+
17
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/CodeQL/badge.svg
18
+ :target: https://github.com/molssi-seamm/liquid_structure_step/security/code-scanning
19
+ :alt: Code Quality
20
+
21
+ .. image:: https://github.com/molssi-seamm/liquid_structure_step/workflows/Release/badge.svg
22
+ :target: https://molssi-seamm.github.io/liquid_structure_step/index.html
23
+ :alt: Documentation Status
24
+
25
+ .. image:: https://img.shields.io/pypi/v/liquid_structure_step.svg
26
+ :target: https://pypi.python.org/pypi/liquid_structure_step
27
+ :alt: PyPi VERSION
28
+
29
+ A SEAMM plug-in for the structure of liquids and solutions from molecular dynamics:
30
+ radial distribution functions, coordination numbers, ion pairing and solvation shells.
31
+
32
+ * Free software: BSD-3-Clause
33
+ * Documentation: https://molssi-seamm.github.io/liquid_structure_step/index.html
34
+ * Code: https://github.com/molssi-seamm/liquid_structure_step
35
+
36
+ Features
37
+ --------
38
+
39
+ * Partial radial distribution functions with errors, their first peaks and minima, and
40
+ coordination numbers, with fixed cutoffs where the minima mislead.
41
+ * The pairing of ions: free, solvent-separated (SSIP), contact (CIP) and aggregated
42
+ (AGG) pairs, also for clusters.
43
+ * Solvation shells: coordination numbers per solvent, the most common shells, pairing,
44
+ and residence times.
45
+ * Runs its own MD or analyzes MD earlier in the flowchart, from SEAMM's H5MD files.
46
+
47
+ Acknowledgements
48
+ ----------------
49
+
50
+ This package was created with the `molssi-seamm/cookiecutter-seamm-plugin`_ tool, which
51
+ is based on the excellent Cookiecutter_.
52
+
53
+ .. _Cookiecutter: https://github.com/audreyr/cookiecutter
54
+ .. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
55
+
56
+ Developed by the Molecular Sciences Software Institute (MolSSI_),
57
+ which receives funding from the `National Science Foundation`_ under
58
+ award CHE-2136142.
59
+
60
+ .. _MolSSI: https://molssi.org
61
+ .. _`National Science Foundation`: https://www.nsf.gov
@@ -0,0 +1,177 @@
1
+ # Makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line.
5
+ SPHINXOPTS =
6
+ SPHINXBUILD = sphinx-build
7
+ PAPER =
8
+ BUILDDIR = _build
9
+
10
+ # User-friendly check for sphinx-build
11
+ ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+ $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13
+ endif
14
+
15
+ # Internal variables.
16
+ PAPEROPT_a4 = -D latex_paper_size=a4
17
+ PAPEROPT_letter = -D latex_paper_size=letter
18
+ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19
+ # the i18n builder cannot share the environment and doctrees with the others
20
+ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
+
22
+ .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
+
24
+ help:
25
+ @echo "Please use \`make <target>' where <target> is one of"
26
+ @echo " html to make standalone HTML files"
27
+ @echo " dirhtml to make HTML files named index.html in directories"
28
+ @echo " singlehtml to make a single large HTML file"
29
+ @echo " pickle to make pickle files"
30
+ @echo " json to make JSON files"
31
+ @echo " htmlhelp to make HTML files and a HTML help project"
32
+ @echo " qthelp to make HTML files and a qthelp project"
33
+ @echo " devhelp to make HTML files and a Devhelp project"
34
+ @echo " epub to make an epub"
35
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
37
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38
+ @echo " text to make text files"
39
+ @echo " man to make manual pages"
40
+ @echo " texinfo to make Texinfo files"
41
+ @echo " info to make Texinfo files and run them through makeinfo"
42
+ @echo " gettext to make PO message catalogs"
43
+ @echo " changes to make an overview of all changed/added/deprecated items"
44
+ @echo " xml to make Docutils-native XML files"
45
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46
+ @echo " linkcheck to check all external links for integrity"
47
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
+
49
+ clean:
50
+ rm -rf $(BUILDDIR)/*
51
+
52
+ html:
53
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54
+ @echo
55
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56
+
57
+ dirhtml:
58
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59
+ @echo
60
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61
+
62
+ singlehtml:
63
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64
+ @echo
65
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66
+
67
+ pickle:
68
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69
+ @echo
70
+ @echo "Build finished; now you can process the pickle files."
71
+
72
+ json:
73
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74
+ @echo
75
+ @echo "Build finished; now you can process the JSON files."
76
+
77
+ htmlhelp:
78
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79
+ @echo
80
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
81
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
82
+
83
+ qthelp:
84
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85
+ @echo
86
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
87
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/liquid_structure_step.qhcp"
89
+ @echo "To view the help file:"
90
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/liquid_structure_step.qhc"
91
+
92
+ devhelp:
93
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94
+ @echo
95
+ @echo "Build finished."
96
+ @echo "To view the help file:"
97
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/liquid_structure_step"
98
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/liquid_structure_step"
99
+ @echo "# devhelp"
100
+
101
+ epub:
102
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103
+ @echo
104
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105
+
106
+ latex:
107
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108
+ @echo
109
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
111
+ "(use \`make latexpdf' here to do that automatically)."
112
+
113
+ latexpdf:
114
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115
+ @echo "Running LaTeX files through pdflatex..."
116
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
117
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118
+
119
+ latexpdfja:
120
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121
+ @echo "Running LaTeX files through platex and dvipdfmx..."
122
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124
+
125
+ text:
126
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127
+ @echo
128
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
129
+
130
+ man:
131
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132
+ @echo
133
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134
+
135
+ texinfo:
136
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137
+ @echo
138
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139
+ @echo "Run \`make' in that directory to run these through makeinfo" \
140
+ "(use \`make info' here to do that automatically)."
141
+
142
+ info:
143
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144
+ @echo "Running Texinfo files through makeinfo..."
145
+ make -C $(BUILDDIR)/texinfo info
146
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147
+
148
+ gettext:
149
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150
+ @echo
151
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152
+
153
+ changes:
154
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155
+ @echo
156
+ @echo "The overview file is in $(BUILDDIR)/changes."
157
+
158
+ linkcheck:
159
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160
+ @echo
161
+ @echo "Link check complete; look for any errors in the above output " \
162
+ "or in $(BUILDDIR)/linkcheck/output.txt."
163
+
164
+ doctest:
165
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166
+ @echo "Testing of doctests in the sources finished, look at the " \
167
+ "results in $(BUILDDIR)/doctest/output.txt."
168
+
169
+ xml:
170
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171
+ @echo
172
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
173
+
174
+ pseudoxml:
175
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176
+ @echo
177
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
@@ -0,0 +1,17 @@
1
+ API Documentation
2
+ =================
3
+
4
+ Contents:
5
+
6
+ .. toctree::
7
+ :maxdepth: 2
8
+
9
+ modules
10
+
11
+
12
+ Indices and tables
13
+ ------------------
14
+
15
+ * :ref:`genindex`
16
+ * :ref:`modindex`
17
+ * :ref:`search`
@@ -0,0 +1 @@
1
+ .. include:: ../AUTHORS.rst