forked from cclib/cclib.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
275 lines (157 loc) · 12.5 KB
/
index.html
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview — cclib 1.7.1 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/increase_max_width.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="How to install" href="how_to_install.html" />
<link rel="prev" title="Table of Contents" href="contents.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="contents.html" class="icon icon-home"> cclib
</a>
<div class="version">
1.7
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#summary">Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="#how-to-use-cclib">How to use cclib</a></li>
<li class="toctree-l2"><a class="reference internal" href="#about-cclib">About cclib</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.7.1)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="bridge.html">Bridges to other packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_dev.html">Development parsed data</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="contents.html">cclib</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="contents.html" class="icon icon-home"></a> »</li>
<li>Overview</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/cclib/cclib/blob/master/doc/sphinx/index.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h1>
<p><strong>cclib</strong> is an <a class="reference external" href="https://en.wikipedia.org/wiki/Open_source">open source</a> library, written in <a class="reference external" href="https://www.python.org">Python</a>, for parsing and interpreting the results of computational chemistry packages.
The goals of cclib are centered around the reuse of data obtained from these programs and contained in output files, specifically:</p>
<ul class="simple">
<li><p>extract (parse) data from the output files generated by multiple programs</p></li>
<li><p>provide a consistent interface to the results of computational chemistry calculations, particularly those results that are useful for algorithms or visualization</p></li>
<li><p>facilitate the implementation of algorithms that are not specific to a particular computational chemistry package</p></li>
<li><p>to maximize interoperability with other open source computational chemistry and cheminformatic software libraries</p></li>
</ul>
<div class="section" id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>The current version is <strong>cclib 1.7.1</strong> (see the <a class="reference external" href="changelog.html">changelog</a> for what’s new). The following programs are supported and systematically tested at the versions given in parentheses:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://www.scm.com/product/adf/">ADF</a> (versions 2007 and 2013)</p></li>
<li><p><a class="reference external" href="https://daltonprogram.org/">DALTON</a> (versions 2013 and 2015)</p></li>
<li><p><a class="reference external" href="http://classic.chem.msu.su/gran/gamess/">Firefly</a>, formerly known as PC GAMESS (version 8.0)</p></li>
<li><p><a class="reference external" href="https://www.msg.chem.iastate.edu/gamess/">GAMESS (US)</a> (versions 2014 and 2017)</p></li>
<li><p><a class="reference external" href="https://web.archive.org/web/20190613042645/http://www.cfs.dl.ac.uk/">GAMESS-UK</a> (versions 7.0 and 8.0)</p></li>
<li><p><a class="reference external" href="https://gaussian.com/">Gaussian</a> (versions 09 and 16)</p></li>
<li><p><a class="reference external" href="https://www.schrodinger.com/products/jaguar">Jaguar</a> (versions 7.0 and 8.3)</p></li>
<li><p><a class="reference external" href="https://gitlab.com/Molcas/OpenMolcas">Molcas</a> (version 18.0)</p></li>
<li><p><a class="reference external" href="https://www.molpro.net/">Molpro</a> (versions 2006 and 2012)</p></li>
<li><p><a class="reference external" href="http://openmopac.net/">MOPAC</a> (version 2016)</p></li>
<li><p><a class="reference external" href="https://nwchemgit.github.io/">NWChem</a> (versions 6.0, 6.1, 6.5 and 6.6)</p></li>
<li><p><a class="reference external" href="https://orcaforum.kofo.mpg.de/app.php/portal">ORCA</a> (versions 4.0 and 4.1)</p></li>
<li><p><a class="reference external" href="https://psicode.org/">Psi4</a> (versions 1.0 and 1.2.1)</p></li>
<li><p><a class="reference external" href="https://q-chem.com/">Q-Chem</a> (versions 4.2 and 5.1)</p></li>
<li><p><a class="reference external" href="http://www.turbomole-gmbh.com/">Turbomole</a> (versions 5.9 and 7.2)</p></li>
</ul>
<p>Output files from other versions of the above programs may still work, and regression tests are always welcome. The following legacy parsers are still tested as regressions, but not actively maintained:</p>
<ul class="simple">
<li><p>Psi3 (version 3.4)</p></li>
</ul>
<p>Many types of output data are parsed by cclib, including atom coordinates, orbital information, vibrational modes and TD-DFT calculations. See the page on <a class="reference external" href="data.html">Extracted Data</a> for a complete list with coverage for the different programs. Several <a class="reference external" href="methods.html">calculation methods</a> are also provided for interpreting the electronic properties of molecules.</p>
</div>
<div class="section" id="how-to-use-cclib">
<h2>How to use cclib<a class="headerlink" href="#how-to-use-cclib" title="Permalink to this headline">¶</a></h2>
<p>You can download the <a class="reference external" href="https://github.com/cclib/cclib/releases/download/v1.7.1/cclib-1.7.1.zip">source package for cclib 1.7.1</a> or the <a class="reference external" href="https://github.com/cclib/cclib/archive/master.zip">current development version</a> (from the <a class="reference external" href="https://github.com/cclib/cclib">GitHub repository</a>). For information on packages available in various Linux distributions, installing the source code and requirements, as well as basic usage, the <a class="reference external" href="how_to_install.html">How to install</a> is a good place to start.</p>
<p>If you need further help, find a bug, need new features or have any question, please send email to the <a class="reference external" href="https://sourceforge.net/projects/cclib/lists/cclib-users">mailing list</a> or submit an issue to the <a class="reference external" href="https://github.com/cclib/cclib/issues">tracker</a>.</p>
</div>
<div class="section" id="about-cclib">
<h2>About cclib<a class="headerlink" href="#about-cclib" title="Permalink to this headline">¶</a></h2>
<p>The code behind cclib was started as a collaboration between Noel O’Boyle, Adam Tenderholt and Karol M. Langner (see page about <a class="reference external" href="development.html">Development</a> for details) and is licensed under the <a class="reference external" href="https://en.wikipedia.org/wiki/BSD_licenses#3-clause_license_(%22BSD_License_2.0%22,_%22Revised_BSD_License%22,_%22New_BSD_License%22,_or_%22Modified_BSD_License%22)">BSD 3-clause license</a>. Other developers are encouraged to contribute to this open source project – send an email to the <a class="reference external" href="https://sourceforge.net/projects/cclib/lists/cclib-devel">developers mailing list</a>. Applications that use cclib include <a class="reference external" href="http://gausssum.sourceforge.net/">GaussSum</a> and <a class="reference external" href="https://qmforge.net/">QMForge</a>. It has also been used in the <a class="reference external" href="https://doi.org/10.1021/jacs.5b05600">literature</a>.</p>
<p>If you use cclib in your scientific work, please support our work by adding a reference to the following article:</p>
<div class="line-block">
<div class="line">N. M. O’Boyle, A. L. Tenderholt, K. M. Langner, <em>cclib: a library for package-independent computational chemistry algorithms</em>, J. Comp. Chem. 29 (5), pp. 839-845, <strong>2008</strong> (<a class="reference external" href="https://doi.org/10.1002/jcc.20823">DOI</a>).</div>
<div class="line"><br /></div>
</div>
<p>A record for the latest release is also available on <a class="reference external" href="https://zenodo.org/record/1407790">Zenodo</a>.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="how_to_install.html" class="btn btn-neutral float-right" title="How to install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="contents.html" class="btn btn-neutral float-left" title="Table of Contents" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2021, cclib Development Team.
</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>