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

Use phasorpy-data repo instead of Zenodo in GitHub Actions #74

Merged
merged 3 commits into from
Jun 26, 2024

Conversation

cgohlke
Copy link
Member

@cgohlke cgohlke commented Jun 20, 2024

Description

This PR enables GitHub Actions to use data files from the new phasorpy-data repository instead of Zenodo.

This should make GitHub Actions a little faster and more reliable.

Some third-party data files used during testing and in tutorials remain on Zenodo.

The "official" source of the data files remains on Zenodo.

Release note

Summarize the changes in the code block below to be included in the
release notes:

Use phasorpy-data repo instead of Zenodo in GitHub Actions

Checklist

  • The pull request title, summary, and description are concise.
  • Related issues are linked in the description.
  • New dependencies are explained.
  • The source code and documentation can be distributed under the MIT license.
  • The source code adheres to code standards.
  • New classes, functions, and features are thoroughly tested.
  • New, user-facing classes, functions, and features are documented.
  • New features are covered in tutorials.
  • No files other than source code, documentation, and project settings are added to the repository.

Copy link
Contributor

@bruno-pannunzio bruno-pannunzio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cgohlke for making this change that was necessary for enhancing reliability.

If I understood correctly, the FLUTE dataset is the only one that is still only in Zenodo, so maybe we can think of a way to create a similar dataset with out own data, I will look into it.

Also maybe later we can discuss how we approach if us or other collaborator wants to add to the data repository.

@cgohlke cgohlke merged commit b16e7a4 into phasorpy:main Jun 26, 2024
13 checks passed
@cgohlke cgohlke deleted the data_on_github branch June 26, 2024 02:50
schutyb pushed a commit to schutyb/phasorpy that referenced this pull request Jun 26, 2024
@cgohlke
Copy link
Member Author

cgohlke commented Jun 26, 2024

If I understood correctly, the FLUTE dataset is the only one that is still only in Zenodo, so maybe we can think of a way to create a similar dataset with out own data, I will look into it.

Thanks. Yes, the PhasorPy project really needs a "poster" dataset that can be used to demonstrate the many capabilities of the library and used to generate a project logo. Ideally it would be:

  • licensed permissively
  • small
  • experimental data
  • relevant, e.g., discussed in a peer-reviewed publication
  • in a common format like PTU (not .REF, .TIF, etc.)
  • including a reference (e.g. a IRF or measurement of a known standard)

Also maybe later we can discuss how we approach if us or other collaborator wants to add to the data repository.

I think we should keep the existing PhasorPy Zenodo organization as the one official place to share datasets. Anyone can contribute there with proper license and attribution. The GitHub repository should be for small files used internally during the CI runs.

schutyb pushed a commit to schutyb/phasorpy that referenced this pull request Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants