EPWpy.default.set_default

Classes

SetDefaultVals([code])

Internal helper class that defines and manages default parameter values used throughout the EPWpy framework.

class EPWpy.default.set_default.SetDefaultVals(code=None)

Bases: object

Internal helper class that defines and manages default parameter values used throughout the EPWpy framework.

This class is not intended to be instantiated directly by users. It is primarily used internally to initialize consistent default paths, code settings, and runtime parameters across different EPWpy modules.

Parameters:

code (str or None, optional) -- Name or path of the simulation code for which default values are being set. Typically 'qe', 'epw', or 'bgw'. Default is None.

code

Identifier or path of the code for which defaults apply.

Type:

str or None

home

Current working directory when the object is initialized. Used as the default base path for relative directories.

Type:

str

Notes

• This class is invoked internally by EPWpy setup and configuration modules.

• Modifying defaults manually is discouraged; use higher-level configuration interfaces instead.

• The defaults defined here ensure that all components of EPWpy share a consistent runtime environment.

Examples

>>> from EPWpy.default.set_default import SetDefaultVals
>>> defaults = SetDefaultVals(code="<path to qe bin>")
>>> print(defaults.home)
'/home/user/current_project'

create_writer(type_input=None)

Creates a writer to write jobs

default_checks(type_input)

default_values()

Putting default values in respective dictionaries

---

get_default_writer()

Gets the writer

import_struct(type_input)

print_struct()

read_config(type_input)

Reads a configure file to build EPWpy calculation

set_values(type_input)

Fills default keys with values provided by user

update_script_date()

Gives a unique name to script

write_sbatch_statements()

Writes the sbatch statements