diff --git a/.github/workflows/validate-zenodo.yaml b/.github/workflows/validate-zenodo.yaml new file mode 100644 index 0000000..e640ec7 --- /dev/null +++ b/.github/workflows/validate-zenodo.yaml @@ -0,0 +1,23 @@ +name: Check zenodo metadata + +on: + push: + paths: + - '.zenodo.json' + - '.github/workflows/validate-zenodo.yaml' + +jobs: + check-zenodo-metadata: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-node@v4 + with: + node-version: '22' + - name: Install dependencies + run: npm install zenodraft@0.14.1 + - name: Check .zenodo.json file + run: | + npx zenodraft metadata validate .zenodo.json \ No newline at end of file diff --git a/.zenodo.json b/.zenodo.json new file mode 100644 index 0000000..fa9dc55 --- /dev/null +++ b/.zenodo.json @@ -0,0 +1,63 @@ +{ + "creators": [ + { + "name": "Zhang, Net", + "orcid": "0000-0003-2664-451X", + "affiliation": "The Ohio State University" + }, + { + "name": "Campolongo, Elizabeth G.", + "orcid": "0000-0003-0846-2413", + "affiliation": "The Ohio State University" + }, + { + "name": "Thompson, Matthew J.", + "orcid": "0000-0003-0583-8585", + "affiliation": "The Ohio State University" + }, + { + "name": "Hilmar, Lapp", + "orcid": "0000-0001-9107-0714", + "affiliation": "Neuromatch, Inc." + }, + { + "name": "Menon, Sreejith", + "orcid": "0009-0009-6277-2413", + "affiliation": "Google" + }, + { + "name": "Gu, Jianyang", + "orcid": "0000-0002-4060-7427", + "affiliation": "The Ohio State University" + }, + { + "name": "Nandi, Arnab", + "orcid": "0000-0002-4138-603X", + "affiliation": "The Ohio State University" + } + ], + "description": "Image clustering tool using embeddings with Streamlit interface. Supports GPU-accelerated dimensionality reduction and clustering with automatic CPU fallback.", + "keywords": [ + "imageomics", + "embeddings", + "clustering", + "visualization", + "image-analysis" + ], + "title": "Image Embedding Explorer", + + "version": "0.1.0", + + "license": {"id": "MIT"}, + "publication_date": "2026-03-02", + + "grants": [ + {"id": "021nxhr62::2118240"} + ], + + "references": [ + "Ilharco, G., Wortsman, M., Wightman, R., Gordon, C., Carlini, N., Taori, R., Dave, A., Shankar, V., Namkoong, H., Miller, J., Hajishirzi, H., Farhadi, A., & Schmidt, L. (2021). OpenCLIP [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.5143773", + "VanderPlas, J., Granger, B. E., Heer, J., Moritz, D., Wongsuphasawat, K., Satyanarayan, A., Lees, E., Timofeev, I., Welsh, B., & Sievert, S. (2018). Altair: Interactive Statistical Visualizations for Python. Journal of Open Source Software, 3(32), 1057. https://doi.org/10.21105/joss.01057", + "Streamlit (Version 1.40.0) [Computer software]. (2024). Snowflake Inc. https://github.com/streamlit/streamlit" + ] +} diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..eb97f0c --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,57 @@ +abstract: >- + Image clustering tool using embeddings with Streamlit interface. + Supports GPU-accelerated dimensionality reduction and clustering + with automatic CPU fallback. +authors: + - family-names: Zhang + given-names: Net + orcid: "https://orcid.org/0000-0003-2664-451X" + affiliation: The Ohio State University + - family-names: Campolongo + given-names: Elizabeth G. + orcid: "https://orcid.org/0000-0003-0846-2413" + affiliation: The Ohio State University + - family-names: Thompson + given-names: Matthew J. + orcid: "https://orcid.org/0000-0003-0583-8585" + affiliation: The Ohio State University + - family-names: Hilmar + given-names: Lapp + affiliation: Neuromatch, Inc. + orcid: "https://orcid.org/0000-0001-9107-0714" + affiliation: The Ohio State University + - family-names: Menon + given-names: Sreejith + orcid: "https://orcid.org/0009-0009-6277-2413" + affiliation: Google + - family-names: Gu + given-names: Jianyang + orcid: "https://orcid.org/0000-0002-4060-7427" + affiliation: The Ohio State University + - family-names: Nandi + given-names: Arnab + orcid: "https://orcid.org/0000-0002-4138-603X" + affiliation: The Ohio State University +cff-version: 1.2.0 +date-released: "2026-03-02" +identifiers: + - description: "The GitHub release URL of tag v0.1.0." + type: url + value: "https://github.com/Imageomics/emb-explorer/releases/tag/v0.1.0" + # TODO: update after release + - description: "The GitHub URL of the commit tagged with v0.1.0." + type: url + value: "https://github.com/Imageomics/emb-explorer/tree/" +keywords: + - imageomics + - embeddings + - clustering + - visualization + - image-analysis +license: MIT +message: "If you find this software helpful in your research, please cite both the software." +repository-code: "https://github.com/Imageomics/emb-explorer" +title: "Image Embedding Explorer" +version: 0.1.0 +doi: # TODO: update after ZENODO release +type: software \ No newline at end of file