Skip to content

Latest commit

 

History

History
61 lines (49 loc) · 5.18 KB

README.md

File metadata and controls

61 lines (49 loc) · 5.18 KB
Raw

Cytomine front-end

Presentation

The Cytomine-WebUI is the official front-end for Cytomine, developed in VueJS.
You will find more information about the Cytomine project on the website.
You can also find, on our official documentation how to install it and an user guide.

The main features of this new front-end are :

  • A complete new Cytomine experience.
  • Support of internationalization i.e. multiple languages (English and French currently available). You can contribute by adding new languages (See here).
  • Reactive application.
  • New lists of project, image, job with sorting, searching and filtering.
  • Display details of images, jobs and projects in all the lists.
  • A complete refactoring of the image viewer to focus on the main part : the image. The other components have been developed to be discreet and can be fold in if necessary. The viewer is now compatible with tablets.
  • Rotation of images at any specific angle.
  • Set up of magnification and resolution of each image directly from the viewer or the image list.
  • Zoom beyond the maximum resolution of an image by activating a digital zoom.
  • Display more than one image into a viewer for efficient comparison. These opened images can be linked to synchronize your navigation and allow you to easily browse though multiple images at once.
  • Draw annotations with a preselected term.
  • Opacity of each term color can be specificly set up.
  • Straight lines and Free hand lines annotations are now available.
  • Brightness, Contrast, Saturation and Hue of a image can be set up during visualization.
  • The Workspace feature allows you to open multiple projects and image and go back to a currently opened image or project.
  • A quick search across the platform is available in the top navigation bar.
  • An advanced panel allowing you to search all across the platform.
  • Set for projects default annotation layers and default property which will be displayed at the opening of an image.
  • Follow in real time an other user viewer or part of viewer, only if this user have allowed the Cytomine platform to broadcast it.
  • Simplification of user managment in projects.
  • Change the ontology of a project is now possible.
  • Edition of ontology terms had been simplified.
  • Adding attached files to a project, a image, or an annotation is now possible.
  • Manage files in storage is enriched by total size on disk and list of sub images for archived or converted images.

Installation

This section assumes that you have access to an instance of Cytomine (especially Cytomine-core) and an installed proxy. These two conditions are filled if you have used Cytomine-bootstrap. The following steps will allow you to run a front-end interacting with this instance:

  • Execute npm install to install the dependencies;
  • Change the value of constants CYTOMINE_CORE_HOST and CYTOMINE_UPLOAD_HOST in src/utils/constants.js ; you may also update other constants according to your Cytomine instance or your preferences;
  • Execute npm run build to build all the files into a dist folder.
  • Configure your proxy to redirect http request on the index.html file or replace the dist folder in your Cytomine-bootstrap by this one.

Local installation

This section assumes that you have access to an instance of Cytomine (especially Cytomine-core). The following steps will allow you to run locally a front-end interacting with this instance:

  • Execute npm install to install the dependencies ;
  • Change the value of constants CYTOMINE_CORE_HOST and CYTOMINE_UPLOAD_HOST in src/utils/constants.js ; you may also update other constants according to your Cytomine instance or your preferences;
  • Execute npm run serve to start a web server serving the front end (by default on localhost:8080).

Remarks:

  • If the front-end is not expected to run on the same host/port as the core, NGINX should be configured to allow CORS addressed to the core
  • When using our software, we kindly ask you to show our website URL and our logo in all your work (web site, publications, studies, oral presentations, manuals, ...). If you use Cytomine for scientific purpose, please cite Marée et al., Bioinformatics 2016 as reference paper. See our license files for additional details.

Code of Conduct

We subscribe to the Contributor Convenant Code of Conduct for a respectful community.