Skip to content

Work chains: Adopt consistent naming for namespaces #662

@mbercx

Description

@mbercx

Currently, there is some inconsistency in how we are naming the namespaces of the subprocesses of the work chains. For example:

  • PwRelaxWorkChain uses base and base_scf for the PwBaseWorkChain namespaces of the geometry optimization and the final SCF.
  • PwBandsWorkChain uses scf and bands for the PwBaseWorkChain namespaces of the SCF calculation and the band structure calculation.

We should consider if we can find a consistent naming scheme for the namespaces of the subprocesses. One question here is if the namespace should reflect the subprocess or the purpose of the calculation. We should probably also avoid namespace nestings like relax.relax (which is the reason why the PwRelaxWorkChain uses base for the PwBaseWorkChain of the geometry optimization). My suggestion is to try and use the final part of the entry point for the work chains, and add the purpose of the calculation in case of PwBaseWorkChains (especially if there are multiple, of course). So, we'd get the following namespaces:

  • PwBaseWorkChain: base_<calculation_purpose>, e.g. base_scf, base_relax, ...
  • PwRelaxWorkChain: relax (possibly add relax_type if there are multiple relax types in the work chain)
  • PwBandsWorkChain: bands
  • PdosWorkChain: pdos

But of course, other suggestions are more than welcome!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions