Materials-Consortia / Materials-Consortia/optimade-python-tools

Versioning models independently of this package

Open
#609 1 comment 0 reactions 1 assignee View on GitHub

@ml-evs is already working on this.

Since Dec 6, 2022.

models needs discussion suggestions
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Following the comments around maintaining two parallel releases of the specification, we should have a discussion about how we want to version our models in the future.

Is the API stable enough to be able to pluck the models out into a separate repository where they can be versioned as releases, or does this add too much overhead on what will hopefully be fairly static objects? [additionally two model versions could not be used simultaneously with this approach]

Should we explicitly add logic for versioning models in this package, e.g. extend OptimadeField to include some kind of "supported versions" attribute per field, so that different implementations can be validated (for example) with different model versions?

Paraphrased from post by @ml-evs in https://github.com/Materials-Consortia/optimade-python-tools/issues/593#issuecomment-731199620

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.