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

Adding the property_ranges query parameter and associated metadata #481

Open
wants to merge 39 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
3b9cbc5
Intermediate progress writing property ranges parameter.
JPBergsma Jun 26, 2023
eae1679
Added metadata fields to be able to use property ranges query parameter.
JPBergsma Jun 27, 2023
f00b52d
Small corrections.
JPBergsma Jun 28, 2023
2a0bef8
moved property ranges to single_entryendpoint query param + further r…
JPBergsma Jun 29, 2023
4a00af4
Some small changes after proof reading.
JPBergsma Jun 29, 2023
6905d7f
added that fields should be placed in the range dictionary.
JPBergsma Jun 29, 2023
d579c6e
Some more sentences that had to be moved to a new line.
JPBergsma Jun 30, 2023
6792962
Update optimade.rst
JPBergsma Jun 30, 2023
93ecd0b
removed unintentional changes in appendix.
JPBergsma Jun 30, 2023
a84c72e
Seperated property_ranges query parameter from the partial data.
JPBergsma Jul 4, 2023
dc11574
Merge branch 'develop' into JPBergsma/property_ranges
ml-evs Dec 19, 2023
17beeef
Apply formatting suggestions from code review
ml-evs Jan 18, 2024
cc89029
Merge branch 'develop' into JPBergsma/property_ranges
ml-evs Jan 18, 2024
6d8e24f
Apply suggestions from review
rartino Mar 22, 2024
680317b
Merge branch 'develop' into JPBergsma/property_ranges
rartino Mar 22, 2024
f2a2799
Merge branch 'develop' into JPBergsma/property_ranges
rartino Mar 22, 2024
63e3821
Minor corrections from review
rartino Mar 22, 2024
0efb5e7
Merge branch 'develop' into JPBergsma/property_ranges
rartino Jun 13, 2024
bf7e5b4
Edit property slice definition [WIP]
rartino Jun 13, 2024
d029756
Edit property slice definition [WIP]
rartino Jun 13, 2024
63f122f
Edit property slice definition [WIP]
rartino Jun 13, 2024
f863308
Edit property slice definition [WIP]
rartino Jun 13, 2024
a73029a
Edit property slice definition [WIP]
rartino Jun 13, 2024
c098e47
Improve handing of Python dependencies
rartino Jun 14, 2024
4f704c1
Improve handing of Python dependencies
rartino Jun 14, 2024
266545b
Improve handing of Python dependencies
rartino Jun 14, 2024
e562f49
Revert "Improve handing of Python dependencies"
rartino Jun 14, 2024
315546a
Edit property slice definition [WIP]
rartino Jun 14, 2024
ce9661b
Small sentence fix
giovannipizzi Jun 14, 2024
358157f
Clarifying the part on dimension names.
giovannipizzi Jun 14, 2024
7e29652
Apply suggestions from review
rartino Jun 15, 2024
085030d
Define the term array for OPTMADE data types
rartino Jun 15, 2024
b3a96a0
Fix examples for slicing assuming a trajectory cartesian_site_coordin…
rartino Jun 15, 2024
6231d2a
Adjust confusing phrasing about slicing based on review comment
rartino Jun 15, 2024
9f639d1
Apply suggestions from code review
giovannipizzi Jul 4, 2024
46eafb5
Apply suggestions from code review
giovannipizzi Jul 4, 2024
657a696
Change the format of property_slices to the syntax dim_xxx[start:stop…
rartino Jun 18, 2024
919b83d
Fix in formulation for property_slices format dim_xxx[start:stop:step]
rartino Oct 18, 2024
a623390
Apply suggestions from review
rartino Oct 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from review
Co-authored-by: Antanas Vaitkus <antanas.vaitkus90@gmail.com>
  • Loading branch information
rartino and vaitkus authored Mar 22, 2024
commit 6d8e24ff58c124039238931c61599f420eaad555
4 changes: 2 additions & 2 deletions optimade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1265,12 +1265,12 @@ Single Entry URL Query Parameters
The slices are 0-based, i.e. the first value has index 0, and inclusive i.e. for the range :val:`:10:20:1` the last value returned belongs to index 20.

General support for :field:`property_ranges` is OPTIONAL, however particular property definitions may themselves deviate from this and place stricter requirements on implementations.
Databases MUST use these ranges for properties where the dimension is listed under :field:`indexable_dimensions`, if this is not the case, the database MAY return more data than was specified in the range.
Databases MUST use these ranges for properties where the dimension is listed under :field:`indexable_dim`, if this is not the case, the database MAY return more data than was specified in the range.

If a dimension is not specified, it is assumed that the whole range in that dimension is requested.
If one or more values are not present at one of the requested combination of indexes, the server MAY either decide to return null or if possible adjust the returned range so the indexes for which no value is defined are no longer part of the range.
The latter is only allowed when no defined values would be lost.
For dense arrays that may mean that the field :field:`returned_range` differs from the requested range.
For dense arrays that may mean that the field :field:`returned_ranges` differs from the requested range.
However, when a value is explicitly set to :val:`null` to indicate that the underlying property has no defined values, then :val:`null` MUST be returned.

Example: In this example the Cartesian site positions are requested for particles 30 through 70 for 1 out of every 10 frames of the first 1000 frames of a trajectory with ID :val:`id_12345`.
Expand Down
Loading