docs(readme): Start adding documentation for React version
This commit is contained in:
Erik Ziegler committed
1 parent
ec51cb7a6c
commit
6658623f1f
365 files changed
+52155
-15
No files matched your search
@@ -0,0 +1,15 @@
|
||||
# Architecture
|
||||
|
||||
The ohif-viewer package provides two different build processes:
|
||||
|
||||
# create-react-app
|
||||
|
||||
> [create-react-app](https://github.com/facebook/create-react-app) provides pre-configured build process for developing front-end applications with [React](https://reactjs.org/).
|
||||
|
||||
The ohif-viewer package can be run as a create-react-app application. This is useful for development, debugging, or evolving ohif-viewer into your own custom imaging application.
|
||||
|
||||
# Rollup
|
||||
|
||||
> [Rollup](https://rollupjs.org/guide/en) is a module bundler for JavaScript. It uses the new standardized format for code modules included in the ES6 revision of JavaScript.
|
||||
|
||||
The ohif-viewer package can be built with Rollup to provide a set of React components which can be dropped into a larger application. Specifically, the ohif-viewer package provides a React component named `OHIFViewer` which is the entire viewer, configurable via React `props`. This is useful for including the OHIF Viewer in a larger web application, as the entire application can be provided via a `<script>` tag with no build process required.
|
||||
@@ -0,0 +1,87 @@
|
||||
# Getting Started
|
||||
|
||||
## Getting the Code
|
||||
|
||||
Either clone the repository using Git:
|
||||
|
||||
````bash
|
||||
git clone git@github.com:OHIF/Viewers.git
|
||||
````
|
||||
|
||||
or [Download the latest Master as a ZIP File](https://github.com/OHIF/Viewers/archive/master.zip).
|
||||
|
||||
## Test the archive against our public DICOM server
|
||||
|
||||
## Set up and test the OHIF Viewer application:
|
||||
1. [Install Node.js](https://nodejs.org/en/)
|
||||
2. Open a new terminal tab in the `ohif-viewer` directory and install all dependency packages via NPM
|
||||
|
||||
````bash
|
||||
cd Packages-react/ohif-viewer
|
||||
npm install
|
||||
````
|
||||
|
||||
3. Run the application
|
||||
|
||||
````bash
|
||||
npm start
|
||||
````
|
||||
|
||||
Note: This will connect to our public DICOMWeb server so you can verify your installation. Follow the next section to connect to your own local or remote DICOMWeb server.
|
||||
|
||||
4. Launch the OHIF Viewer Study List by visiting [http://localhost:3000/](http://localhost:3000/) in a web browser.
|
||||
|
||||
**If everything is working correctly, you should see the studies from our public archive when you visit the Study List.**
|
||||
|
||||
5. Double-click on a Study in the Study List to launch it in the Viewer
|
||||
|
||||
**If everything is working correctly, you should see your study load into the Viewer.**
|
||||
|
||||
## Set up a local DICOM server
|
||||
|
||||
1. Choose and install an Image Archive
|
||||
2. Upload some data into your archive (e.g. with DCMTK's [storescu](http://support.dcmtk.org/docs/storescu.html) or your archive's web interface)
|
||||
3. Keep the server running
|
||||
|
||||
#### Open Source DICOM Image Archive Options
|
||||
|
||||
Archive | Installation
|
||||
-------------------------------------------|
|
||||
[DCM4CHEE Archive 5.x](https://github.com/dcm4che/dcm4chee-arc-light) | [Installation with Docker](https://github.com/dcm4che/dcm4chee-arc-light/wiki/Running-on-Docker)
|
||||
[Orthanc](https://www.orthanc-server.com/) | [Installation with Docker](http://book.orthanc-server.com/users/docker.html)
|
||||
[DICOMcloud](https://github.com/DICOMcloud/DICOMcloud) (**DICOM Web only**)| [Installation](https://github.com/DICOMcloud/DICOMcloud#running-the-code)
|
||||
[OsiriX](http://www.osirix-viewer.com/) (**Mac OSX only**) |
|
||||
[Horos](https://www.horosproject.org/) (**Mac OSX only**) |
|
||||
|
||||
*Feel free to make a Pull Request if you want to add to this list.*
|
||||
|
||||
## Set up and test the OHIF Viewer application:
|
||||
1. [Install Node.js](https://nodejs.org/en/)
|
||||
2. Open a new terminal tab in the `ohif-viewer` directory and install all dependency packages via NPM
|
||||
|
||||
````bash
|
||||
cd Packages-react/ohif-viewer
|
||||
npm install
|
||||
````
|
||||
|
||||
3. Run the application using one of the available configuration files.
|
||||
|
||||
````bash
|
||||
REACT_APP_CONFIG=$(cat ../../config-react/ccc.json)
|
||||
npm start
|
||||
````
|
||||
|
||||
This uses the [Custom Environment Variables of Create-React-App](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables) to pass in your configuration. The example above will not work on Windows. Please visit the link to read about how to set environment variables on Windows.
|
||||
|
||||
4. Launch the OHIF Viewer Study List by visiting [http://localhost:3000/](http://localhost:3000/) in a web browser.
|
||||
|
||||
**If everything is working correctly, you should see the Study List from your archive when you visit the Study List.**
|
||||
|
||||
5. Double-click on a Study in the Study List to launch it in the Viewer
|
||||
|
||||
**If everything is working correctly, you should see your study load into the Viewer.**
|
||||
|
||||
#### Troubleshooting
|
||||
* If you receive a *"No Studies Found"* message and do not see your studies, try changing the Study Date filters to a wider range.
|
||||
* If you see a 'Loading' message which never resolves, check your browser JavaScript console inside the Developer Tools to identify any errors.
|
||||
* If you see any errors in your server console, check the [Troubleshooting](../troubleshooting.md) page for more in depth advice.
|
||||
@@ -0,0 +1,60 @@
|
||||
# Meteor Packages
|
||||
|
||||
### Commands (*ohif-commands*)
|
||||
### Core (*ohif-core*)
|
||||
|
||||
## Cornerstone Package (*ohif-cornerstone*)
|
||||
|
||||
This package contains a number of front-end libraries that help us build web-based medical imaging applications.
|
||||
|
||||
These are:
|
||||
- [dicomParser](https://github.com/cornerstonejs/dicomParser):
|
||||
A lightweight JavaScript library for parsing DICOM P10 byte streams in modern web browsers (IE10+), Node.js, and Meteor.
|
||||
|
||||
- [Cornerstone Core](https://github.com/cornerstonejs/cornerstone):
|
||||
A lightweight JavaScript library for displaying medical images in modern web browsers that support the HTML5 canvas element.
|
||||
|
||||
- [Cornerstone Tools](https://github.com/cornerstonejs/cornerstoneTools):
|
||||
A library built on top of cornerstone that provides a set of common tools needed in medical imaging to work with images and stacks of images
|
||||
|
||||
- [Cornerstone Math](https://github.com/cornerstonejs/cornerstoneMath):
|
||||
Math and computational geometry functionality for Cornerstone
|
||||
|
||||
- [Cornerstone WADO Image Loader](https://github.com/cornerstonejs/cornerstoneWADOImageLoader):
|
||||
A Cornerstone Image Loader for DICOM P10 instances over HTTP. This can be used to integrate cornerstone with WADO-URI servers or any other HTTP based server that returns DICOM P10 instances (e.g. Orthanc or custom servers).
|
||||
|
||||
- [Hammer.js](https://github.com/hammerjs/hammer.js):
|
||||
A JavaScript library for multi-touch gestures
|
||||
|
||||
### Design (*ohif-design*)
|
||||
### DICOM Services (*ohif-dicom-services*)
|
||||
It contains a number of helper functions for retrieving common value types (e.g. JSON, patient name, image frame) from a DICOM image. This package is for server-side usage.
|
||||
|
||||
### Hanging Protocols (*ohif-hanging-protocols*)
|
||||
### Header (*ohif-header*)
|
||||
### Hotkeys (*ohif-hotkeys*)
|
||||
|
||||
### Lesion Tracker (*ohif-lesiontracker*)
|
||||
This package stores all of the oncology-specific tools and functions developed for the Lesion Tracker application. Here we store, for example, the Target measurement and Non-target pointer tools that are used to monitor tumour burden over time.
|
||||
|
||||
This package also stores Meteor components for the interactive lesion table used in the Lesion Tracker, and dialog boxes for the callbacks attached to the Target and Non-target tools.
|
||||
|
||||
### Logging (*ohif-log*)
|
||||
### Logging (*ohif-measurements*)
|
||||
### Metadata (*ohif-metadata*)
|
||||
### Polyfilling Functionality (*ohif-polyfill*)
|
||||
|
||||
### Select Tree UI (*ohif-select-tree*)
|
||||
### Server Settings UI (*ohif-servers*)
|
||||
### Studies (*ohif-studies*)
|
||||
### Study List UI (*ohif-study-list*)
|
||||
### Common Themes (*ohif-themes-common*)
|
||||
### Theming (*ohif-themes*)
|
||||
### User Management (*ohif-user-management*)
|
||||
### User (*ohif-user*)
|
||||
|
||||
### Basic Viewer Components (*ohif-viewerbase*)
|
||||
This is the largest package in the repository. It holds a large number of re-usable Meteor components that are used to build both the OHIF Viewer and Lesion Tracker.
|
||||
|
||||
### WADO Proxy (*ohif-wadoproxy*)
|
||||
Proxy for CORS
|
||||
@@ -0,0 +1,13 @@
|
||||
# Troubleshooting
|
||||
|
||||
# Common Problems
|
||||
|
||||
Problem | Most Common Reasons
|
||||
--------|--------------------
|
||||
** Can't retrieve Study List over DICOMWeb** | 1. QIDO root URL is incorrect<br> 2. DICOM Web is not enabled on PACS
|
||||
** Can't retrieve images** | 1. WADO Root URL is incorrect<br> 2. DICOM Web is not enabled on PACS<br> 3. HTTP Basic Authentication username and password are incorrect or not provided.
|
||||
|
||||
# Debugging Steps
|
||||
### Can't retrieve Study List over DICOMWeb
|
||||
|
||||
1. Check that you can query your PACS using an alternative DICOM Web client (e.g. cURL, or a Web Browser). If you cannot, then your PACS is configured incorrectly. Refer to the documentation of the image archive.
|
||||
Reference in new issue
Block a user