Conversation
…d adding necessary TUPS to Pangaea translator/query builder
…ame; map to cvWhats (NOAA) and parameter (PANGAEA); update query builders and validation logic; maintain backward compatibility for cv_whats
…terms, notes and examples Correcting typos and imporving docstrings clarity
…i valued query parameters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR introduces a unified query translation layer for PANGAEA, aligning it with NOAA’s structured interface in pyleotups. It standardizes parameter naming, enables multi-value logical operations, and improves documentation consistency across datasets.
Key Features & Improvements
1. Unified Query Interface
Replaces backend-specific parameters with a consistent API across providers
Introduces:
Removes reliance on raw q input in favor of structured parameters
2. PANGAEA Query Builder
Adds build_pangaea_query() to translate unified kwargs into PANGAEA-compatible query strings
Supports:
Ensures safe query construction and prevents malformed queries
3. Logical Operators for Multi-Value Parameters
Adds *_and_or support (aligned with NOAA design):
variable_name_and_or = "and" / "or"
investigators_and_or = "and" / "or"
topic_and_or = "and" / "or"
Implements logic in query builder:
AND → implicit (space-separated)
OR → explicit ((A OR B))
4. Topic Filtering (PANGAEA-specific)
Introduces new parameter:
topicto reduce search space based on requirementsSupports:
6. Improved Docstrings (PANGAEA)
Upgrades PangaeaDataset.search_studies() documentation to match NOAA standards
7. Test Updates
Design Philosophy
This PR moves pyleotups toward a backend-agnostic query interface, where: