informatics-isi-edu / openseadragon-viewer

2D viewer with openseadragon
Apache License 2.0
5 stars 2 forks source link

openseadragon-viewer (OSD viewer)

Overview

A 2D viewer based on OpenSeadragon with image annotation capability, in-time filtering, and in-view scalebar. This application is mainly used in combination with Chaise viewer app.

Installation

See OSD viewer installation.

Usage

openseadragon can be used as a standalone web application, or inside an iframe to communicate with its parent web application. It's mainly designed to work with the Chaise viewer app.

See openseadargon-viewer usage for more details.

Code Contribute

When developing new code for OSD viewer, please make sure you're following these steps:

  1. create a new branch and make your updates to the code in the branch (avoid changing master branch directly);
  2. do your own quality assurance;
  3. update the regression tests (if applicable);
  4. make sure you can deploy your code without any issues (make deploy should not fail);
  5. make sure that all regression tests are passing before submitting the pull request;
  6. make your pull request, assign it to yourself, and ask someone to review your code.
    • Try to provide as much information as you can on your PR. Explain the issues that the PR is fixing, and the changes that you've done in the PR.
    • Provide examples if applicable.
    • Deploy your changes to a server if applicable and provide links. You should not expect reviewers to deploy your code.
    • Resolve the conflicts with master before merging the code (and go through the process of making sure tests are good to go).

Help and Contact

Please direct questions and comments to the project issue tracker at GitHub.

License

openseadragon-viewer is made available as open source under the Apache License, Version 2.0. Please see the LICENSE file for more information.

About Us

openseadragon-viewer is developed in the Informatics Systems Research Division at the USC Information Sciences Institute.