Skip to content

Add Google sheet access instructions. #134

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.

Sign up for GitHub

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

Merged
CoreySpohn merged 2 commits into from
Dec 4, 2025
Merged

Add Google sheet access instructions. #134

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70d03ae
docs: add Google sheet access instructions.
steigersg Dec 3, 2025
3df0c06
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 3, 2025
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
9 changes: 6 additions & 3 deletions docs/user/functionality.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@ the yield codes. The system manages the complex and inconsistent file structures
AYO and EXOSIMS inputs and outputs by organizing them into a hierarchical tree of nodes
representing files and directories. This abstraction creates a consistent API that
allows users to query data without needing to understand and parse the underlying
data products. For collaboration purposes, the valid queries are managed in a [Google Sheet](https://docs.google.com/spreadsheets/d/1qZ-JH0xnYSqeWOrirEIvJ-NcoMVu90pDgeRsqbDUcxM/edit?usp=sharing) where collaborators have linked the EXOSIMS and AYO keys to a universal key in `yieldplotlib`.
This Google Sheet is processed into a `key_map` which is updated daily. Users can update
the sheet, download it as a CSV file, and process it locally for development.
data products. For collaboration purposes, the valid queries are managed in a
[Google Sheet](https://docs.google.com/spreadsheets/d/1qZ-JH0xnYSqeWOrirEIvJ-NcoMVu90pDgeRsqbDUcxM/edit?usp=sharing) where collaborators have linked the EXOSIMS and AYO keys to a
universal key in `yieldplotlib`. This Google Sheet is processed into a `key_map` which
is updated daily. Users can view, download, and process the CSV file locally for development.
If you would like editing access to the Google Sheet, reach out via email to
Corey (corey.a.spohn@nasa.gov) or Sarah (ssteiger@stsci.edu).

Once the yield packages are loaded and parsed, a getter can be called on the directory objects
to return the corresponding value from the respective yield code, for example:
Expand Down