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

I fenton thumbnail jpg #712

Merged
merged 4 commits into from
Aug 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ After you are done, create a pull request to the original repo with the changes.
Once you have submitted your model / datasource for inclusion in the catalog, you might want to also consider submitting a project to provide some more details about how they have been used in your research.

#### Adding a new project to the catalog
To submit a project, enter the relevant details about it [here](https://sci.vision/new-project). This will create a .json file in the correct format. Open a [new issue on GitHub](https://github.com/alan-turing-institute/scivision/issues/new?assignees=&labels=catalog%2Cproject&projects=&template=new-project.md&title=%5BPROJECT%5D), attaching the .json file and an appropriate thumbnail (a 256x256 .png or .jpg file with the same name as the datasource). You will need a GitHub account.
To submit a project, enter the relevant details about it [here](https://sci.vision/new-project). This will create a .json file in the correct format. Open a [new issue on GitHub](https://github.com/alan-turing-institute/scivision/issues/new?assignees=&labels=catalog%2Cproject&projects=&template=new-project.md&title=%5BPROJECT%5D), attaching the .json file and an appropriate thumbnail (a 256x256 .jpg file with the same name as the datasource). You will need a GitHub account.

Once your submission is accepted, the project will become visible to other users of Scivision, and it will appear on the [website](https://sci.vision/project-grid).

Expand All @@ -160,6 +160,6 @@ This section describes how to add a catalog entry by hand. These steps are an a

Fork the [Scivision repository](https://github.com/alan-turing-institute/scivision). Fill in [the form](https://sci.vision/new-project) on the scivision website to get the details for your project in to the correct format. On your new branch, add this information to the end of `projects.json` (found in `scivision/src/scivision/catalog/projects/`), under `"entries"`.

Additionally, upload a suitable thumbnail to the [thumbnail project folder](https://github.com/alan-turing-institute/scivision/tree/main/src/scivision/catalog/data/thumbnails/projects). This must be a 256x256 .png or .jpg file with the same name as the datasource.
Additionally, upload a suitable thumbnail to the [thumbnail project folder](https://github.com/alan-turing-institute/scivision/tree/main/src/scivision/catalog/data/thumbnails/projects). This must be a 256x256 .jpg file with the same name as the datasource.

After you are done, create a pull request to the original repo with the changes. A Scivision maintainer will approve the addition, and it will appear on the [website](https://sci.vision/project-grid).
2 changes: 1 addition & 1 deletion docs/data_repository_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You should include a `LICENSE` file, so that Scivision users who come across it

When viewing the dataset in [sci.vision](https://sci.vision/#/datasource-grid) a dataset thumbnail is required. The thumbnail can be an interesting image or slice of the dataset that catches the attention of the Scivision user (creativity encouraged!).

- It must be a 256x256 PNG or JPEG file
- It must be a 256x256 JPEG file
- The file name should be the name of the dataset as in the catalog

.. _data-api:
Expand Down
2 changes: 1 addition & 1 deletion docs/model_repository_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ You should include a `LICENSE` file in the repository, so that Scivision users w

When viewing the model in [sci.vision](https://sci.vision/#/model-grid) a model thumbnail is required. The thumbnail can be an interesting image explaining the model and that catches the attention of the Scivision user (creativity encouraged!).

- It must be a 256x256 PNG or JPEG file
- It must be a 256x256 JPEG file
- The file name should be the name of the model as in the catalog

.. _api:
Expand Down
Loading