Skip to content

Add methods to results#1187

Draft
andypbarrett wants to merge 27 commits intomainfrom
add-methods-to-results
Draft

Add methods to results#1187
andypbarrett wants to merge 27 commits intomainfrom
add-methods-to-results

Conversation

@andypbarrett
Copy link
Copy Markdown
Contributor

@andypbarrett andypbarrett commented Jan 29, 2026

This PR modifies DataCollection and DataGranule in the following ways.

Addresses #999

  • Attribute-like methods have @property decorators and behave like attributes.
  • DataCollection.summary now includes collection name (umm.EntryTitle)
  • DataCollection.summary returns file_format rather than full data_type entry
  • Add DataCollection.file_format to return list of file formats in collection
  • Modify DataCollection.data_type to return list of dicts instead of string
  • Adds migration guide to release notes
  • Updates docs
Pull Request (PR) draft checklist - click to expand
  • Please review our
    contributing documentation
    before getting started.
  • Populate a descriptive title. For example, instead of "Updated README.md", use a
    title such as "Add testing details to the contributor section of the README".
    Example PRs: #763
  • Populate the body of the pull request with:
  • Update CHANGELOG.md with details about your change in a section titled
    ## Unreleased. If such a section does not exist, please create one. Follow
    Common Changelog for your additions.
    Example PRs: #763
  • Update the documentation and/or the README.md with details of changes to the
    earthaccess interface, if any. Consider new environment variables, function names,
    decorators, etc.
Pull Request (PR) merge checklist - click to expand

Please do your best to complete these requirements! If you need help with any of these
requirements, you can ping the @nsidc/earthaccess-support team in a comment and we
will help you out!

  • Add unit tests for any new features.
  • Apply formatting and linting autofixes. You can add a GitHub comment in this Pull
    Request containing "pre-commit.ci autofix" to automate this.
  • Ensure all automated PR checks (seen at the bottom of the "conversation" tab) pass.
  • Get at least one approving review.

📚 Documentation preview 📚: https://earthaccess--1187.org.readthedocs.build/en/1187/

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jan 29, 2026

Binder 👈 Launch a binder notebook on this branch for commit e61f2ca

I will automatically update this comment whenever this PR is modified

Binder 👈 Launch a binder notebook on this branch for commit c5e139f

Binder 👈 Launch a binder notebook on this branch for commit 0145f77

Binder 👈 Launch a binder notebook on this branch for commit 01ff1f8

Binder 👈 Launch a binder notebook on this branch for commit 9608662

Binder 👈 Launch a binder notebook on this branch for commit 80d3ca1

@andypbarrett
Copy link
Copy Markdown
Contributor Author

To Do

  • Add migration guide to release notes
  • Update docs
  • Add to CHANGELOG.md

@andypbarrett
Copy link
Copy Markdown
Contributor Author

andypbarrett commented Mar 17, 2026

Based on discussion at the Colab Cafe, this will break a lot of tutorials and also dependencies. We need to decide when we merge this and whether it is included in a version 0.0 to version 1.0 bump.

The change needs to be communicated in several channels to make people aware of the change and when it will happen.

We could also add a warning to the methods changed to let people know that they will change and when they will change.

Suggest we use FutureWarning and add this as part of a separate PR for pre-1.0 release.

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.

2 participants