Skip to content
This repository has been archived by the owner on May 7, 2021. It is now read-only.

Generalize the SsspFamily to the UpfFamily group plugin #29

Closed
wants to merge 1 commit into from

Conversation

sphuber
Copy link
Contributor

@sphuber sphuber commented May 28, 2020

Fixes #26

The functionality provided by the SsspFamily is very useful but can
currently, by design choice, only be used for actual SSSP configurations.
The original idea of the plugin and SsspFamily is to not make it
easier for peopl to work with the SSSP but also make it less likely that
incorrect SSSP configurations are used.

However, there is still a common use case for UPF families that are not
strict SSSP configurations. Therefore, we generalize it to the new
plugin UpfFamily which represents a generic family of UPF files. The
SsspFamily then simply is a subclass as it just imposes additional
constraints.

The idea is that the SsspFamily can only be used for SSSP
configurations and all other use cases will employ the UpfFamily
plugin instead. Note that it will be difficult to prevent people from
using the SsspFamily group for non-SSSP families, but there will never
be a way to prevent this. Instead we will simply not provide a command
line interface to create SsspFamily instances from anything other than
the official resources from the Materials Cloud Archive entry.

The functionality provided by the `SsspFamily` is very useful but can
currently, by design choice, only be used for actual SSSP configurations.
The original idea of the plugin and `SsspFamily` is to not make it
easier for peopl to work with the SSSP but also make it less likely that
incorrect SSSP configurations are used.

However, there is still a common use case for UPF families that are not
strict SSSP configurations. Therefore, we generalize it to the new
plugin `UpfFamily` which represents a generic family of UPF files. The
`SsspFamily` then simply is a subclass as it just imposes additional
constraints.

The idea is that the `SsspFamily` can only be used for SSSP
configurations and all other use cases will employ the `UpfFamily`
plugin instead. Note that it will be difficult to prevent people from
using the `SsspFamily` group for non-SSSP families, but there will never
be a way to prevent this. Instead we will simply not provide a command
line interface to create `SsspFamily` instances from anything other than
the official resources from the Materials Cloud Archive entry.
@sphuber sphuber closed this May 7, 2021
@sphuber sphuber deleted the feature/026/upf-family branch May 7, 2021 14:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should functionality to be generalized to normal UPF families as well?
1 participant