From 17cd2ec3253dc4306bf5b456cbd7b4da6b532e24 Mon Sep 17 00:00:00 2001 From: Michele Bortolomeazzi Date: Mon, 18 Nov 2024 17:31:04 +0100 Subject: [PATCH] Update README.md --- README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3cd5374..e68e845 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ ![Badge_OMERO](https://github.com/MicheleBortol/omero-vitessce/actions/workflows/omero_plugin.yml/badge.svg) ![Badge_PyPI](https://img.shields.io/pypi/v/omero-vitessce?label=pypi%20package) - OMERO.omero_vitessce ======================= @@ -58,15 +57,12 @@ The plugin can be used with: Clicking the link will open a new tab with the viewer displaying the selected configuration. ![Link-List-image](https://github.com/user-attachments/assets/7f556f86-7edf-49a0-bf2a-9c5f168922b1) - - - **Generating custom config files**: The form allows the user to automatically generate a config file with the selected parameters. After clicking the `Generate Config` button a config file is generated and attached to the dataset/image. The viewer displaying the autogenerated configuration will open in a new tab. ![Form-image](https://github.com/user-attachments/assets/6e9bbb79-6b40-4d5f-bb0f-48f7bc6a13f1) - #### Open-with: Right click on a `dataset` or an `images` in the left-panel and select `open-with` -> `Vitessce`. This will open the vitessce viewer in a new tab using the first configuration file attachement. @@ -76,7 +72,8 @@ This will open the vitessce viewer in a new tab using the first configuration fi After autogenerating or selecting a config file, the Vitessce viewer is opened in a new tab: ![Viewer GIF](https://github.com/user-attachments/assets/0f1effac-e681-4782-a69e-76702451fcbb) - +The viewer panels can also be rearranged to better fit the image type/size. +![Viewer slide](https://github.com/user-attachments/assets/5c8c9559-ea2c-44c9-acbe-26caaf951432) ### Config files The omero-vitessce plugin considers all files with the `.json` extension attached to the image or dataset as config files for the viewer. @@ -149,8 +146,7 @@ Images and data can be served through: - `omero_vitessce/vitessce_json_rois/ID1,ID2,...` endpoint where `ID1,ID2,...` is a comma-separated list of image ids, to get the first shape of each ROI in `json` format. Example showing ROIs from OMERO displayed in the omero-vitessce viewer window: -![image](https://github.com/user-attachments/assets/223072d6-9aa7-4b96-a199-65bbab863c1b) - +![ROI comparison](https://github.com/user-attachments/assets/807026b8-4ed2-4977-890b-73aa9c547ca2) Development ======================= @@ -223,7 +219,6 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.
You will also see any lint errors in the console. - ### `npm run build` Builds the app for production to the `build` folder and copies the @@ -243,4 +238,3 @@ You will need to have the app configured in your OMERO.web install: It bundles React in production mode and optimizes the build for the best performance. See the Create React App section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. -