Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Single SOFT entity for structure resource #196

Merged
merged 5 commits into from
Sep 4, 2024

Conversation

CasperWA
Copy link
Collaborator

Closes #195

This PR slightly renames the Python API and adds a new SOFT7 entity to single-handedly describe an OPTIMADE structure resource.

This is at the cost of DLite support for this entity, due to the usage of the dict type (supported by SOFT7), and also a slight loss of semantics, as the dict property values will inevitably not be documented further.

Copy link

codecov bot commented Dec 16, 2023

Codecov Report

Attention: Patch coverage is 62.50000% with 48 lines in your changes missing coverage. Please review.

Project coverage is 73.31%. Comparing base (55e6985) to head (cd29f08).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
oteapi_optimade/dlite/parse.py 62.31% 26 Missing ⚠️
oteapi_optimade/_utils.py 57.14% 21 Missing ⚠️
oteapi_optimade/models/strategies/parse.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #196      +/-   ##
==========================================
- Coverage   75.45%   73.31%   -2.15%     
==========================================
  Files          14       15       +1     
  Lines         546      637      +91     
==========================================
+ Hits          412      467      +55     
- Misses        134      170      +36     
Flag Coverage Δ
local 73.31% <62.50%> (-2.15%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CasperWA and others added 2 commits September 3, 2024 22:19
Expand species and assemblies

Also, add all space_group* properties to the new entity.
@CasperWA CasperWA force-pushed the cwa/close-195-minimize-soft-model branch from 128ce23 to 1235cf3 Compare September 3, 2024 20:20
Move entities out of Python package to a top-level 'entities' folder.

Implement convenience functions for parsing species and assemblies from
a single entity instance. These are available to import from
`oteapi_optimade`.
@CasperWA CasperWA merged commit a012912 into main Sep 4, 2024
15 of 17 checks passed
@CasperWA CasperWA deleted the cwa/close-195-minimize-soft-model branch September 4, 2024 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Minimize SOFT data model to a single file
1 participant