-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
cffc098
commit 64e1715
Showing
2 changed files
with
33 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
# Global parameters | ||
|
||
Global parameters such as number of atoms, temperature and runner information (which run system, e.g. slurm, how many cores, etc.) | ||
Each object in the MALADA workflow needs a `Parameters` object provided at time of instantiation. It holds information such as number of atoms, temperature and runner information (which run system, e.g. slurm, how many cores, etc.). Some of these are optional, and default values can be used. Others have to be explicitly set for the workflow not to fail. For a detailed description of each parameter, see the API documentation. | ||
|
||
## Required parameters | ||
|
||
- temperature | ||
- number_of_atoms | ||
- element | ||
|
||
## Optional parameters | ||
|
||
- crystal_structure | ||
- base_folder | ||
- dft_calculator | ||
- md_calculator | ||
- pseudopotential | ||
- run_system | ||
- dft_slurm | ||
- md_slurm | ||
- dft_conv_accuracy_meVperatom | ||
- maximum_cutoff_try | ||
- maximum_kpoint_try | ||
- dft_scf_accuracy_per_atom_Ry | ||
- md_at_gamma_point | ||
- maximum_number_of_timesteps | ||
- time_step_fs | ||
- md_thermostat_controller | ||
- snapshot_parsing_beginning | ||
- snapshot_parsing_temperature_tolerance_percent | ||
- snapshot_parsing_criterion | ||
- number_of_snapshots | ||
- distance_metric_snapshots | ||
- distance_metric_snapshots_cutoff |