Skip to content

Commit 120dea5

Browse files
committed
Added the official documentation in the main repository
1 parent cc70eff commit 120dea5

4 files changed

Lines changed: 317 additions & 262 deletions

File tree

UserGuide/apireference.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,34 @@ Here the parameters read in the &relax name list are read and setup.
4040
:members:
4141

4242

43+
44+
The Utilities Module
45+
----------------
46+
47+
This module both provides the constrains and the IOinput
48+
49+
IOInfo class
50+
^^^^^^^^^^^^
51+
52+
Use this class to make the python-sscha print information during the minimization
53+
54+
.. autoclass:: sscha.Utilities.IOInfo
55+
:members:
56+
57+
58+
Constraints
59+
^^^^^^^^^^^
60+
61+
The constrains are a member of the Utilities module.
62+
To implement constrains on phonon modes, use the ModeProjection class
63+
64+
65+
.. autoclass:: sscha.Utilities.ModeProjection
66+
:members:
67+
68+
69+
70+
4371
The Cluster Module
4472
------------------
4573

UserGuide/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
'sphinx.ext.doctest',
3535
'sphinx.ext.intersphinx',
3636
'sphinx.ext.todo',
37+
'sphinx.ext.autosectionlabel',
3738
'sphinx.ext.coverage',
3839
'sphinx.ext.mathjax',
3940
'sphinx.ext.ifconfig',

0 commit comments

Comments
 (0)