1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
:py:mod:`aiida`
===============
.. py:module:: aiida
.. autodoc2-docstring:: aiida
:allowtitles:
Subpackages
-----------
.. toctree::
:titlesonly:
:maxdepth: 3
aiida.repository
aiida.parsers
aiida.tools
aiida.plugins
aiida.transports
aiida.cmdline
aiida.common
aiida.manage
aiida.orm
aiida.engine
aiida.schedulers
Package Contents
----------------
Functions
~~~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`get_strict_version <aiida.get_strict_version>`
- .. autodoc2-docstring:: aiida.get_strict_version
:summary:
* - :py:obj:`get_version <aiida.get_version>`
- .. autodoc2-docstring:: aiida.get_version
:summary:
* - :py:obj:`_get_raw_file_header <aiida._get_raw_file_header>`
- .. autodoc2-docstring:: aiida._get_raw_file_header
:summary:
* - :py:obj:`get_file_header <aiida.get_file_header>`
- .. autodoc2-docstring:: aiida.get_file_header
:summary:
* - :py:obj:`load_ipython_extension <aiida.load_ipython_extension>`
- .. autodoc2-docstring:: aiida.load_ipython_extension
:summary:
Data
~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`__copyright__ <aiida.__copyright__>`
- .. autodoc2-docstring:: aiida.__copyright__
:summary:
* - :py:obj:`__license__ <aiida.__license__>`
- .. autodoc2-docstring:: aiida.__license__
:summary:
* - :py:obj:`__version__ <aiida.__version__>`
- .. autodoc2-docstring:: aiida.__version__
:summary:
* - :py:obj:`__authors__ <aiida.__authors__>`
- .. autodoc2-docstring:: aiida.__authors__
:summary:
* - :py:obj:`__paper__ <aiida.__paper__>`
- .. autodoc2-docstring:: aiida.__paper__
:summary:
* - :py:obj:`__paper_short__ <aiida.__paper_short__>`
- .. autodoc2-docstring:: aiida.__paper_short__
:summary:
API
~~~
.. py:data:: __copyright__
:canonical: aiida.__copyright__
:value: 'Copyright (c), This file is part of the AiiDA platform. For further information please visit http://...'
.. autodoc2-docstring:: aiida.__copyright__
.. py:data:: __license__
:canonical: aiida.__license__
:value: 'MIT license, see LICENSE.txt file.'
.. autodoc2-docstring:: aiida.__license__
.. py:data:: __version__
:canonical: aiida.__version__
:value: '2.2.2'
.. autodoc2-docstring:: aiida.__version__
.. py:data:: __authors__
:canonical: aiida.__authors__
:value: 'The AiiDA team.'
.. autodoc2-docstring:: aiida.__authors__
.. py:data:: __paper__
:canonical: aiida.__paper__
:value: 'S. P. Huber et al., "AiiDA 1.0, a scalable computational infrastructure for automated reproducible w...'
.. autodoc2-docstring:: aiida.__paper__
.. py:data:: __paper_short__
:canonical: aiida.__paper_short__
:value: 'S. P. Huber et al., Scientific Data 7, 300 (2020).'
.. autodoc2-docstring:: aiida.__paper_short__
.. py:function:: get_strict_version()
:canonical: aiida.get_strict_version
.. autodoc2-docstring:: aiida.get_strict_version
.. py:function:: get_version() -> str
:canonical: aiida.get_version
.. autodoc2-docstring:: aiida.get_version
.. py:function:: _get_raw_file_header() -> str
:canonical: aiida._get_raw_file_header
.. autodoc2-docstring:: aiida._get_raw_file_header
.. py:function:: get_file_header(comment_char: str = '# ') -> str
:canonical: aiida.get_file_header
.. autodoc2-docstring:: aiida.get_file_header
.. py:function:: load_ipython_extension(ipython)
:canonical: aiida.load_ipython_extension
.. autodoc2-docstring:: aiida.load_ipython_extension
|
