ohif-viewer/README.md
2019-04-25 15:00:17 -04:00

5.0 KiB

Viewers

This repo contains the OHIF DICOM Viewer and Lesion Tracker, and various shared meteor packages.


CircleCI codecov All Contributors code style: prettier semantic-release

NPM version NPM downloads MIT License

Why?

Building a web based medical imaging viewer from scratch is time intensive, hard to get right, and expensive. Instead of re-inventing the wheel, you can use the OHIF Viewer as a rock solid platform to build on top of. The Viewer is a React Progressive Web Application that can be embedded in existing applications via it's packaged source (ohif-viewer) or hosted stand-alone. The Viewer exposes configuration and extensions to support workflow customization and advanced functionality at common integration points.

If you're interested in using the OHIF Viewer, but you're not sure it supports your use case check out our docs. Still not sure, or you would like to propose new features? Don't hesitate to create an issue or open a pull request ^_^

Documentation is available here: http://docs.ohif.org/

Issues

Looking to contribute? Look for the [Good First Issue][good-first-issue] label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[See Bugs][bugs]

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

[See Feature Requests][requests-feature]

Questions

For questions related to using the library, please visit our support community, or file an issue on GitHub.

[Google Group][google-group]

License

MIT © OHIF

Demos

OHIF Viewer - A general-purpose radiology viewer with a variety of tools exposed.

Lesion Tracker - A prototype viewer focused on oncology metrics.

Community

Have questions? Try posting on our google groups forum.

Docker usage

Following the instructions below, the docker image will listen for DICOM connections on port 4242, and for web traffic on port 8042. The default username for the web interface is orthanc, and the password is orthanc.

Temporary data storage

docker run --rm -p 4242:4242 -p 8042:8042 jodogne/orthanc-plugins

Persistent data storage

  1. Create a persistant data volume for Orthanc to use

    docker create --name sampledata -v /sampledata jodogne/orthanc-plugins
    

    Note: On Windows, you need to use an absolute path for the data volume, like so:

    docker create --name sampledata -v '//C/Users/erik/sampledata' jodogne/orthanc-plugins
    
  2. Run Orthanc from Docker with the data volume attached

    docker run --volumes-from sampledata -p 4242:4242 -p 8042:8042 jodogne/orthanc-plugins
    
  3. Upload your data and it will be persisted