Skip to content

_base

Base jobs for espresso.

prepare_calc 

prepare_calc(
    atoms: Atoms,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
) -> Espresso

Commonly used preparation function to merge parameters and create an Espresso calculator accordingly.

Parameters:

  • atoms (Atoms) –

    Atoms object

  • preset (str | None, default: None ) –

    Name of the preset to use

  • template (EspressoTemplate | None, default: None ) –

    EspressoTemplate to use

  • profile (EspressoProfile | None, default: None ) –

    EspressoProfile to use

  • calc_defaults (dict[str, Any] | None, default: None ) –

    The default calculator parameters.

  • calc_swaps (dict[str, Any] | None, default: None ) –

    Custom kwargs for the espresso calculator. Set a value to quacc.Remove to remove a pre-existing key entirely. For a list of available keys, refer to the ase.calculators.espresso.Espresso calculator.

Returns:

Source code in quacc/recipes/espresso/_base.py 
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
def prepare_calc(
    atoms: Atoms,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
) -> Espresso:
    """
    Commonly used preparation function to merge parameters
    and create an Espresso calculator accordingly.

    Parameters
    ----------
    atoms
        Atoms object
    preset
        Name of the preset to use
    template
        EspressoTemplate to use
    profile
        EspressoProfile to use
    calc_defaults
        The default calculator parameters.
    calc_swaps
        Custom kwargs for the espresso calculator. Set a value to
        `quacc.Remove` to remove a pre-existing key entirely. For a list of available
        keys, refer to the [ase.calculators.espresso.Espresso][] calculator.

    Returns
    -------
    Espresso
        The Espresso calculator.
    """
    calc_defaults = calc_defaults or {}
    calc_swaps = calc_swaps or {}

    calc_defaults["input_data"] = Namelist(calc_defaults.get("input_data"))
    calc_swaps["input_data"] = Namelist(calc_swaps.get("input_data"))

    binary = template.binary if template else "pw"

    if binary in ALL_KEYS:
        calc_defaults["input_data"].to_nested(binary=binary, **calc_defaults)
        calc_swaps["input_data"].to_nested(binary=binary, **calc_swaps)

    calc_defaults = remove_conflicting_kpts_kspacing(calc_defaults, calc_swaps)
    calc_flags = recursive_dict_merge(calc_defaults, calc_swaps)

    return Espresso(
        input_atoms=atoms,
        preset=preset,
        template=template,
        profile=profile,
        **calc_flags,
    )

prepare_copy 

prepare_copy(
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
    calc_params: dict[str, Any] | None = None,
    binary: str = "pw",
) -> dict[SourceDirectory, Filenames] | None

Function that will prepare the files to copy.

Parameters:

Returns:

  • dict –

    Dictionary of files to copy.

Source code in quacc/recipes/espresso/_base.py 
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
def prepare_copy(
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
    calc_params: dict[str, Any] | None = None,
    binary: str = "pw",
) -> dict[SourceDirectory, Filenames] | None:
    """
    Function that will prepare the files to copy.

    Parameters
    ----------
    copy_files
        Files to copy (and decompress) from source to the runtime directory.
    calc_params
        The calculator parameters.
    binary
        The binary to use.

    Returns
    -------
    dict
        Dictionary of files to copy.
    """
    if isinstance(copy_files, str | Path):
        copy_files = [copy_files]

    if isinstance(copy_files, list):
        exact_files_to_copy = prepare_copy_files(calc_params, binary=binary)
        return dict.fromkeys(copy_files, exact_files_to_copy)

    return copy_files

run_and_summarize 

run_and_summarize(
    atoms: Atoms | None = None,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
    additional_fields: dict[str, Any] | None = None,
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
) -> RunSchema

Base function to carry out espresso recipes.

Parameters:

  • atoms (Atoms | None, default: None ) –

    Atoms object

  • preset (str | None, default: None ) –

    Name of the preset to use

  • template (EspressoTemplate | None, default: None ) –

    EspressoTemplate to use

  • profile (EspressoProfile | None, default: None ) –

    EspressoProfile to use

  • calc_defaults (dict[str, Any] | None, default: None ) –

    The default calculator parameters.

  • calc_swaps (dict[str, Any] | None, default: None ) –

    Custom kwargs for the espresso calculator. Set a value to quacc.Remove to remove a pre-existing key entirely. For a list of available keys, refer to the ase.calculators.espresso.Espresso calculator.

  • additional_fields (dict[str, Any] | None, default: None ) –

    Any additional fields to supply to the summarizer.

  • copy_files (SourceDirectory | list[SourceDirectory] | dict[SourceDirectory, Filenames] | None, default: None ) –

    Files to copy (and decompress) from source to the runtime directory.

Returns:

Source code in quacc/recipes/espresso/_base.py 
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
def run_and_summarize(
    atoms: Atoms | None = None,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
    additional_fields: dict[str, Any] | None = None,
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
) -> RunSchema:
    """
    Base function to carry out espresso recipes.

    Parameters
    ----------
    atoms
        Atoms object
    preset
        Name of the preset to use
    template
        EspressoTemplate to use
    profile
        EspressoProfile to use
    calc_defaults
        The default calculator parameters.
    calc_swaps
        Custom kwargs for the espresso calculator. Set a value to
        `quacc.Remove` to remove a pre-existing key entirely. For a list of available
        keys, refer to the [ase.calculators.espresso.Espresso][] calculator.
    additional_fields
        Any additional fields to supply to the summarizer.
    copy_files
        Files to copy (and decompress) from source to the runtime directory.

    Returns
    -------
    RunSchema
        Dictionary of results from [quacc.schemas.ase.Summarize.run][]
    """
    atoms = Atoms() if atoms is None else atoms
    calc = prepare_calc(
        atoms,
        preset=preset,
        template=template,
        profile=profile,
        calc_defaults=calc_defaults,
        calc_swaps=calc_swaps,
    )

    updated_copy_files = prepare_copy(
        copy_files=copy_files,
        calc_params=calc.user_calc_params,
        binary=calc.template.binary,
    )

    geom_file = template.outputname if template and template.binary == "pw" else None

    final_atoms = Runner(atoms, calc, copy_files=updated_copy_files).run_calc(
        geom_file=geom_file
    )

    return Summarize(move_magmoms=True, additional_fields=additional_fields).run(
        final_atoms, atoms
    )

run_and_summarize_opt 

run_and_summarize_opt(
    atoms: Atoms | None = None,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
    opt_defaults: dict[str, Any] | None = None,
    opt_params: OptParams | None = None,
    additional_fields: dict[str, Any] | None = None,
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
) -> RunSchema

Base function to carry out espresso recipes with ASE optimizers.

Parameters:

  • atoms (Atoms | None, default: None ) –

    Atoms object

  • preset (str | None, default: None ) –

    Name of the preset to use

  • template (EspressoTemplate | None, default: None ) –

    EspressoTemplate to use

  • profile (EspressoProfile | None, default: None ) –

    EspressoProfile to use

  • calc_defaults (dict[str, Any] | None, default: None ) –

    The default calculator parameters.

  • calc_swaps (dict[str, Any] | None, default: None ) –

    Custom kwargs for the espresso calculator. Set a value to quacc.Remove to remove a pre-existing key entirely. For a list of available keys, refer to the ase.calculators.espresso.Espresso calculator.

  • opt_defaults (dict[str, Any] | None, default: None ) –

    The default optimization parameters.

  • opt_params (OptParams | None, default: None ) –

    Dictionary of custom kwargs for the optimization process. For a list of available keys, refer to quacc.runners.ase.Runner.run_opt.

  • additional_fields (dict[str, Any] | None, default: None ) –

    Any additional fields to supply to the summarizer.

  • copy_files (SourceDirectory | list[SourceDirectory] | dict[SourceDirectory, Filenames] | None, default: None ) –

    Files to copy (and decompress) from source to the runtime directory.

Returns:

Source code in quacc/recipes/espresso/_base.py 
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
def run_and_summarize_opt(
    atoms: Atoms | None = None,
    preset: str | None = None,
    template: EspressoTemplate | None = None,
    profile: EspressoProfile | None = None,
    calc_defaults: dict[str, Any] | None = None,
    calc_swaps: dict[str, Any] | None = None,
    opt_defaults: dict[str, Any] | None = None,
    opt_params: OptParams | None = None,
    additional_fields: dict[str, Any] | None = None,
    copy_files: (
        SourceDirectory
        | list[SourceDirectory]
        | dict[SourceDirectory, Filenames]
        | None
    ) = None,
) -> RunSchema:
    """
    Base function to carry out espresso recipes with ASE optimizers.

    Parameters
    ----------
    atoms
        Atoms object
    preset
        Name of the preset to use
    template
        EspressoTemplate to use
    profile
        EspressoProfile to use
    calc_defaults
        The default calculator parameters.
    calc_swaps
        Custom kwargs for the espresso calculator. Set a value to
        `quacc.Remove` to remove a pre-existing key entirely. For a list of available
        keys, refer to the [ase.calculators.espresso.Espresso][] calculator.
    opt_defaults
        The default optimization parameters.
    opt_params
        Dictionary of custom kwargs for the optimization process. For a list
        of available keys, refer to [quacc.runners.ase.Runner.run_opt][].
    additional_fields
        Any additional fields to supply to the summarizer.
    copy_files
        Files to copy (and decompress) from source to the runtime directory.

    Returns
    -------
    RunSchema
        Dictionary of results from [quacc.schemas.ase.Summarize.run][]
    """
    atoms = Atoms() if atoms is None else atoms
    calc = prepare_calc(
        atoms,
        preset=preset,
        template=template,
        profile=profile,
        calc_defaults=calc_defaults,
        calc_swaps=calc_swaps,
    )

    updated_copy_files = prepare_copy(
        copy_files=copy_files,
        calc_params=calc.user_calc_params,
        binary=calc.template.binary,
    )

    opt_flags = recursive_dict_merge(opt_defaults, opt_params)

    dyn = Runner(atoms, calc, copy_files=updated_copy_files).run_opt(**opt_flags)

    return Summarize(move_magmoms=True, additional_fields=additional_fields).opt(dyn)