You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ For those who are interested in the source code, the following figure shows the
64
64
| |-- module_surchem The module for calculating the surface charge correction.
65
65
| |-- module_vdw The module for calculating the van der Waals correction.
66
66
| |-- module_xc The module for calculating the exchange-correlation energy and potential.
67
-
|-- module_hamilt_lcao The module for defining the Hamiltonian in LCAO calculations.
67
+
|-- source_lcao The module for defining the Hamiltonian in LCAO calculations.
68
68
| |-- hamilt_lcaodft The module for defining the Hamiltonian in LCAO-DFT calculations.
69
69
| | |-- operator_lcao The module for defining the operators in LCAO-DFT calculations.
70
70
| |-- module_deepks The module for defining the Hamiltonian in DeepKS calculations.
@@ -79,10 +79,10 @@ For those who are interested in the source code, the following figure shows the
79
79
| `-- hamilt_stodft The module for defining the Hamiltonian in STODFT calculations.
80
80
|-- source_hsolver The module for solving the Hamiltonian with different diagonalization methods, including CG, Davidson in PW
81
81
| | calculations, and scalapack and genelpa in LCAO calculations.
82
-
|-- module_io The module for reading of INPUT files and output properties including band structure, density of states, charge density, etc.
83
-
|-- module_md The module for performing molecular dynamics.
82
+
|-- source_io The module for reading of INPUT files and output properties including band structure, density of states, charge density, etc.
83
+
|-- source_md The module for performing molecular dynamics.
84
84
|-- source_psi The module for defining the wave function and its operations.
85
-
|-- module_relax The module for performing structural optimization.
85
+
|-- source_relax The module for performing structural optimization.
86
86
| |-- relax_new The module for performing structural optimization with new algorithm, optimized for cell and ion simultaneously.
87
87
| `-- relax_old The module for performing structural optimization with old algorithm, optimized for cell and ion separately.
88
88
|-- module_ri The module for performing RI calculations.
@@ -101,7 +101,7 @@ For comments that need to be shown in documents, these formats should be used --
101
101
102
102
A helpful VS Code extension -- [Doxygen Documentation Generator](https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen), can help you formating comments.
103
103
104
-
An practical example is class [LCAO_Deepks](https://github.com/deepmodeling/abacus-develop/blob/deepks/source/module_hamilt_lcao/module_deepks/LCAO_deepks.h), the effects can be seen on [readthedocs page](https://abacus-deepks.readthedocs.io/en/latest/DeePKS_API/classLCAO__Descriptor.html#exhale-class-classLCAO-Descriptor)
104
+
An practical example is class [LCAO_Deepks](https://github.com/deepmodeling/abacus-develop/blob/deepks/source/source_lcao/module_deepks/LCAO_deepks.h), the effects can be seen on [readthedocs page](https://abacus-deepks.readthedocs.io/en/latest/DeePKS_API/classLCAO__Descriptor.html#exhale-class-classLCAO-Descriptor)
105
105
106
106
- Tips
107
107
- Only comments in .h file will be visible in generated by Doxygen + Sphinx;
The current code structure of JSON functionality in Abacus is roughly as follows:
147
147
148
-
- source/module_io
148
+
- source/source_io
149
149
- para_json.cpp: Contains JSON generation and output interfaces directly called by the device in Abacus.
150
150
- json_output/: Contains the functionality encapsulation class `abacusjson.cpp` of RapidJSON in Abacus and code classes for parameter generation in various JSON modules.
151
151
- test: Code testing files in `json_output`.
@@ -160,7 +160,7 @@ In Abacus JSON addition, the following principles need to be followed:
160
160
161
161
3. Use classes as function parameters as much as possible instead of using global classes for obtained parameters. (For example, in `gen_general_info`, `Input`)
162
162
163
-
4. After adding parameters, supplement test code in `module_io/json_output/test`.
163
+
4. After adding parameters, supplement test code in `source_io/json_output/test`.
164
164
165
165
For the current JSON file, there are two JSON modules: `init` and `general_info`, `output_info`.
166
166
Taking `general_info` as an example, the code to be added is as follows:
0 commit comments