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

Check "truth" of CIF exporter

Open
#275 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

adapters good first issue priority/medium tests
Dominant language
Python
Stars
91
Forks
54
PR merge metrics
No merged PRs in 30d

Description

Can someone clarify whether that structure is "correct", as displayed by recent VESTA versions?

If it isn't, maybe we should consider converting to fractionals in the cif exporter (until fractional is added to optimade)? We would have to be careful to deal with e.g. indeterminate lattice vectors and so on, but if the point is to make a file usable by viewers, then its probably worth the effort.

Originally posted by @ml-evs in https://github.com/Materials-Consortia/optimade-python-tools/issues/271#issuecomment-630187598

Answer by @CasperWA in the same issue:

I guess we could retrieve a CIF file from somewhere, e.g., COD, run it through our functions, export it, and see how they match up?

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.

Research direction

Start at the CIF exporter and inspect how its output represents structures for recent VESTA versions. Retrieve a reference CIF, such as one from COD, run it through the project’s functions, and compare the exported result. Done means determining whether the structure is correct and whether fractional coordinates should be supported, including cases with indeterminate lattice vectors.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.