scippneutron.metadata.Person#

class scippneutron.metadata.Person(**data)[source]#

A person.

Attention

Please make sure that you don’t specify personal details without permission!

Specify an ORCID iD whenever possible to make sure the person can be uniquely identified. The name is always required but is often not unique. Other contact information like address or email address are less important and can usually be omitted when an ORCID iD is provided.

Attributes

model_computed_fields

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

model_fields

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

name

Free form name of the person.

orcid_id

ORCID iD of the person.

corresponding

Whether the person is the corresponding / contact author.

owner

Whether the person owns the data.

role

The role that the person played in collecting / processing the data.

address

Physical (work) address of the person.

email

Email address of the person.

affiliation

Affiliation of the person.

address: Annotated[str | None, BeforeValidator(_unpack_variable)]#

Physical (work) address of the person.

affiliation: Annotated[str | None, BeforeValidator(_unpack_variable)]#

Affiliation of the person.

corresponding: bool#

Whether the person is the corresponding / contact author.

email: Annotated[EmailStr | None, BeforeValidator(_unpack_variable)]#

Email address of the person.

model_config: ClassVar[ConfigDict] = {}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: Annotated[str, BeforeValidator(_unpack_variable)]#

Free form name of the person.

orcid_id: Annotated[ORCIDiD | None, BeforeValidator(_unpack_variable)]#

ORCID iD of the person.

owner: bool#

Whether the person owns the data.

role: Annotated[str | None, BeforeValidator(_unpack_variable)]#

The role that the person played in collecting / processing the data.

NeXus and CIF list possible roles.