search

Imageomics / pybioclip

Python package that simplifies using the BioCLIP foundation model.
MIT License
12 stars 3 forks source link

Add citation recommendations that include citing the BioCLIP paper #4

Closed hlapp closed 1 week ago

hlapp commented 5 months ago

Also, we'll want a Citation section in the README (such as at the end) that asks that users not only cite this code but also the BioCLIP paper, I think. But I can make that a separate follow-up issue.

Originally posted by @hlapp in https://github.com/Imageomics/pybioclip/pull/3#pullrequestreview-1969536022

johnbradley commented 1 month ago

My understanding this requires 3 changes:

In hindsight it would have been better to setup Zenodo before creating our first release.

I went into Zenodo and did not see this repo or any Imageomics repos under the list I can add. Perhaps only Imageomics owners can setup the repo within Zenodo. @thompsonmj Can you setup this repo within Zenodo?

egrace479 commented 1 month ago

My understanding this requires 3 changes:

  • Archive the repo in Zenodo to create a DOI
  • Create a CITATION.cff file using the DOI
  • Update readme with the citation details

In hindsight it would have been better to setup Zenodo before creating our first release.

I went into Zenodo and did not see this repo or any Imageomics repos under the list I can add. Perhaps only Imageomics owners can setup the repo within Zenodo. @thompsonmj Can you setup this repo within Zenodo?

I can turn it on; it might require maintainer status on the repo. Based on my experience with archiving Andromeda on Zenodo, we should just set it up with the release and ask them to import the earlier versions after the record is created.

The citation file can be created before for Zenodo to read or afterwards from the Zenodo record.

johnbradley commented 1 week ago

Fixed by #25