update_user_kpoints_settings#

atomate2.vasp.powerups.update_user_kpoints_settings(flow: Job | Flow | Maker, kpoints_updates: dict[str, Any] | Kpoints, name_filter: Optional[str] = None, class_filter: type[Maker] | None = BaseVaspMaker) → Job | Flow | Maker[source]#

Update the user_kpoints_settings of any VaspInputGenerators in the flow.

Alternatively, if a Maker is supplied, the user_kpoints_settings of the maker will be updated.

Note, this returns a copy of the original Job/Flow/Maker. I.e., the update does not happen in place.

Parameters
flowJob or Flow or Maker

A job, flow or Maker.

kpoints_updatesdict

The updates to apply. Can be specified as a dictionary or as a Kpoints object. If a dictionary is supplied, existing keys in user_kpoints_settings will not be modified unless explicitly specified in kpoints_updates.

name_filterstr or None

A filter for the name of the jobs.

class_filterMaker or None

A filter for the VaspMaker class used to generate the flows. Note the class filter will match any subclasses.

Returns
Job or Flow or Maker

A copy of the input flow/job/maker modified to use the updated kpoints settings.