Skip to content

Commit

Permalink
Merge branch 'main' of github.com:bioimage-io/bioimage.io
Browse files Browse the repository at this point in the history
  • Loading branch information
oeway committed Feb 29, 2024
2 parents 70ff86c + fe465e0 commit 8aecc4d
Show file tree
Hide file tree
Showing 14 changed files with 2,099 additions and 790 deletions.
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Supported weight formats](bioimageio_weights_spec)
- [Supported preprocessing](bioimageio_preprocessing_spec)
- [Supported postprocessing](bioimageio_postprocessing_spec)
- [Upload models through Zenodo](/contribute_models/contribute_zenodo.md)
* [Other contributions](/contribute_others/README.md)
* [Resources for developers](/resources_developers/README.md)
- [Python BioImageIO core package](pythoncorepackage)
Expand Down
28 changes: 12 additions & 16 deletions docs/contribute_models/contribute_zenodo.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,25 @@ This tutorial will guide you through the process of uploading a model to the Bio

## Uploading a model

1. Open your web browser and navigate to the Zenodo website at [https://zenodo.org/](https://zenodo.org).
1. Open your web browser and navigate to the Zenodo website at [https://zenodo.org/](https://zenodo.org). You need to create a Zenodo account if you do not have one.
<!-- ![Zenodo initial page](contribute_models/zenodo_upload_01.png) -->
<img src="contribute_models/zenodo_upload_01.png" alt="Zenodo initial page" align="center" width="1000"/>

2. In the Zenodo search bar, enter "bioimage.io" to find the BioImage.IO community.
<!-- ![Find BioImage.IO community](contribute_models/zenodo_upload_03.png) -->
<img src="contribute_models/zenodo_upload_02.png" alt="Find BioImage.IO community" align="center" width="1000"/>

3. Click on the "BioImage.IO" community to access it. You will see the "New upload" button on this page.
<!-- ![BioImage.IO community](contribute_models/zenodo_upload_03.png) -->
<img src="contribute_models/zenodo_upload_03.png" alt="BioImage.IO community" align="center" width="1000"/>

4. Click the "New upload" button to begin the model upload process within the BioImage.IO community.

2. On the right, close to your username, click the "New upload" button to begin the model upload process. Make sure that the repository is set as public.
The files in the BioImage.io zip have to be uploaded one-by-one (See the example in the image below). Note that you can drag & drop all together at once.
<!-- ![New upload](contribute_models/zenodo_upload_04.png) -->
<img src="contribute_models/zenodo_upload_04.png" alt="New upload" align="center" width="1000"/>

5. Follow the on-screen instructions to provide the required information about your model. Make sure to include a clear description, relevant tags, and any necessary documentation. See [this documentation](contribute_models/README.md) for more details on the required files and information.

6. When prompted, upload your model files to Zenodo.
3. Add `bioimage.io` on Keywords and subjects. This is crucial for us to identify your submission.
<!-- ![Find BioImage.IO community](contribute_models/zenodo_upload_03.png) -->
<img src="contribute_models/zenodo_upload_03.png" alt="Find BioImage.IO community" align="center" width="1000"/>

4. Follow the on-screen instructions to provide the required information about your model. Make sure to include a clear description, relevant tags, and any necessary documentation. See [this documentation](contribute_models/README.md) for more details on the required files and information.

7. Review the information you provided and confirm the upload.
5. Once finished, click on Submit.

6. Your model will be proposed as a new contribution to the BioImage Model Zoo automatically. If the model passes all the tests, it will be automatically displayed in the Zoo. If the model does not pass the test, the GitHub users indicated in `maintainers` in the `rdf.yaml` file will be noitified through GitHub. This process can take 12-24h.

8. Your model will be published in the BioImage Model Zoo community on Zenodo.

## Conclusion
You've successfully uploaded your model to the BioImage Model Zoo community on Zenodo. Thank you for your contribution to the BioImage Model Zoo project. Remember that this is a temporary solution while the upload feature on the BioImage.io website is being fixed. We appreciate your patience and support!
Binary file removed docs/contribute_models/zenodo_upload_02.png
Binary file not shown.
Binary file modified docs/contribute_models/zenodo_upload_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/contribute_models/zenodo_upload_04.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8aecc4d

Please sign in to comment.