FaradayInstitution / BPX

BPX schema in pydantic and JSON schema format, and parsers
MIT License
25 stars 12 forks source link

Add version number to a parameter set #25

Closed valentinsulzer closed 2 months ago

valentinsulzer commented 1 year ago

Add version number to a parameter set, separate from (in addition to) the BPX version number.

This would allow us to fix mistakes or inaccuracies in parameter sets while maintaining old versions (and hence not changing any previous results/publications that have been obtained using an old version).

It can probably just be a single version number, doesn't need to be semantic versioning.

rtimms commented 3 months ago

Add a new field to the Header, e.g.


    version: str = Field(
        None,
        alias="Version",
        example="0.1.1",
        description="BPX file version",
    )

@Ubham16

rtimms commented 2 months ago

Fixed by #63