ergo
mainpage.h
Go to the documentation of this file.
1/* Ergo, version 3.8.2, a program for linear scaling electronic structure
2 * calculations.
3 * Copyright (C) 2023 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
4 * and Anastasia Kruchinina.
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 *
19 * Primary academic reference:
20 * Ergo: An open-source program for linear-scaling electronic structure
21 * calculations,
22 * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
23 * Kruchinina,
24 * SoftwareX 7, 107 (2018),
25 * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
26 *
27 * For further information about Ergo, see <http://www.ergoscf.org>.
28 */
34
146 @endverbatim
147 rather than
148 @verbatim
152 @endverbatim
153 for doxygen comments.
154
155 We will possibly add latex doc generation in the future so please keep
156 this in mind and use @@htmlonly for all html specific commands.
157
158
159@subsection filecomments File comments
160 Each file should begin with a header in the following style:
161
162@verbatim
168@endverbatim
169which will result in the following: @n
170Brief description
171@author Author1 <em>responsible</em>
172@author Author2
173
174@htmlonly <hr> @endhtmlonly
175
176 @section install_sec Installation
177
178 @subsection step1 Usual configuration
179
180./configure && make
181
182Options can be passed - see @ref examples for more information.
183
184@subsection correctness Correctness test
185
186make check
187
188Verbose variant:
189make check VERBOSE=1
190
191 @subsection examples Configuration examples
192
193How to install on different machines and libraries
194
195@verbinclude config_examples.txt
196
197
198@htmlonly <hr> @endhtmlonly
199
200@section knownbugs_sec Known bugs
201
202No known bugs right now.
203
204
205 *
206 *
207 *
208 *
209 *
210 *
211 *
212 *
213 *
214 *
215 *
216 */
@ right
Definition Matrix.h:75