search

flatironinstitute / Cryo-EM-Heterogeneity-Challenge-1

The Inaugural Flatiron Institute Cryo-EM Heterogeneity Community Challenge
https://osf.io/8h6fz/
MIT License
4 stars 0 forks source link

DOI, change logs, and zenodo for github repo #35

Open geoffwoollard opened 1 month ago

geoffwoollard commented 1 month ago

I've seen zenodo used as in here

https://zenodo.org/records/6099888 the doi icon at the top of https://github.com/compSPI/simSPI?tab=readme-ov-file

See the changelog: https://github.com/compSPI/simSPI/commits/v0.0.2

This project has a DOI through open science foundation, but that is more for the dataset / project. https://osf.io/8h6fz/

There will be a seperate DOI(s) for a paper(s), which can be attached to the OSF project as a citation(s).

How does zenodo work with PyPI integration?

@DavidHerreros , what do you suggest?

DavidHerreros commented 1 month ago

I've seen zenodo used as in here

https://zenodo.org/records/6099888 the doi icon at the top of https://github.com/compSPI/simSPI?tab=readme-ov-file

Here do you mean adding a badge with the Zenodo DOI?

See the changelog: https://github.com/compSPI/simSPI/commits/v0.0.2

This project has a DOI through open science foundation, but that is more for the dataset / project. https://osf.io/8h6fz/

There will be a seperate DOI(s) for a paper(s), which can be attached to the OSF project as a citation(s).

How does zenodo work with PyPI integration?

The GitHub actions in charge of pushing everything to pypi on merging into main will also copy the README contents into the pypi package webpage. If they DOI is added to the README, it should be automatically reflected on pypi when it is released, is this what you mean?

@DavidHerreros , what do you suggest?

I think it makes sense having a DOI for this repo specifically, although I am not very familiar on how Zenodo works when the repo is updated. The ChangeLog in the Zenodo example is a nice idea as well. There could be a CHANGES.txt in the repo that can be updated everytime a release is done to reflect the new functionalities. Other option is to rely on the PRs descriptions and titles to generate an automatic ChangeLog on a new release, although I would only gow for this one if the PRs are informative enough.

geoffwoollard commented 1 month ago

Let's look into automatic changelog from the PR titles. And where to show this info (PyPI, Zenodo, etc).

geoffwoollard commented 1 month ago

@DavidHerreros, after speaking with Sonya, Pilar and David S, it seems publishing to PyPI is not a big priority. People can just install from github for now. The change logs and doi are more interesting