docs: Remove UI components for now, we will use Storybook instead later. Clean up links and introduction. (#2520)
This commit is contained in:
Erik Ziegler authored and Alireza committed
1 parent
2327b4ae12
commit
00d7192423
104 files changed
+538
-4956
No files matched your search
@@ -6,28 +6,46 @@ sidebar_position: 1
|
||||
|
||||
##### Looking for your Deploy Preview? - <a onClick="function redirect() { window.location.href='/demo/'; } redirect();">Deploy Preview for Viewer</a>
|
||||
|
||||
The [Open Health Imaging Foundation](https://www.ohif.org) is developing an open
|
||||
source framework for constructing web-based medical imaging applications. The
|
||||
application framework is built using modern HTML / CSS / JavaScript and uses
|
||||
[Cornerstone](https://cornerstonejs.org/) at its core to display and manipulate
|
||||
medical images. It is built with Meteor, a Node.js-based full-stack JavaScript
|
||||
platform.
|
||||
|
||||
The [Open Health Imaging Foundation](https://www.ohif.org) is developing an open source framework for constructing web-based medical imaging applications. The application framework is built using modern HTML / CSS / JavaScript and uses [Cornerstone](https://cornerstonejs.org/) at its core to display and manipulate medical images. It is built with Meteor, a Node.js-based full-stack JavaScript platform.
|
||||
|
||||
This documentation concerns the OHIF framework itself and its three example applications: the OHIF Viewer, Lesion Tracker, and the Standalone Viewer.
|
||||
This documentation concerns the OHIF framework itself and its three example
|
||||
applications: the OHIF Viewer, Lesion Tracker, and the Standalone Viewer.
|
||||
|
||||
## The **OHIF Viewer**: A general purpose DICOM Viewer ([demo](http://viewer.ohif.org/))
|
||||
|
||||
|
||||
|
||||
The Open Health Imaging Foundation intends to provide a simple general purpose DICOM Viewer which can be easily extended for specific uses. The primary purpose of the OHIF Viewer is to serve as a testing ground for the underlying packages and the [Cornerstone](https://cornerstonejs.org/) family of libraries.
|
||||
The Open Health Imaging Foundation intends to provide a simple general purpose
|
||||
DICOM Viewer which can be easily extended for specific uses. The primary purpose
|
||||
of the OHIF Viewer is to serve as a testing ground for the underlying packages
|
||||
and the [Cornerstone](https://cornerstonejs.org/) family of libraries.
|
||||
|
||||
## **Lesion Tracker**: An oncology-focused imaging application ([demo](http://lesiontracker.ohif.org/))
|
||||
|
||||
|
||||
|
||||
The Lesion Tracker is designed to facilitate quantitative assessments of tumour burden over time. It is similar in scope to the ePAD Imaging Platform (https://epad.stanford.edu/), developed at Stanford Medicine.
|
||||
The Lesion Tracker is designed to facilitate quantitative assessments of tumour
|
||||
burden over time. It is similar in scope to the ePAD Imaging Platform
|
||||
(https://epad.stanford.edu/), developed at Stanford Medicine.
|
||||
|
||||
## Study List & DICOM Connectivity
|
||||
|
||||
|
||||
|
||||
The solution provides a study list and other resources for connecting to PACS and other Image Archives through standard communication approaches (DICOM Web, DICOM Messages).
|
||||
The solution provides a study list and other resources for connecting to PACS
|
||||
and other Image Archives through standard communication approaches (DICOM Web,
|
||||
DICOM Messages).
|
||||
|
||||
## Standalone Viewer ([demo](ohif-viewer.s3-website.eu-central-1.amazonaws.com/?url=https://raw.githubusercontent.com/OHIF/Viewers/master/StandaloneViewer/etc/sampleDICOM.json))
|
||||
## Standalone Viewer ([demo](https://ohif-viewer.s3-website.eu-central-1.amazonaws.com/?url=https://raw.githubusercontent.com/OHIF/Viewers/master/StandaloneViewer/etc/sampleDICOM.json))
|
||||
|
||||
The Standalone Viewer offers only the client-side portions of the OHIF Viewer with the Study List pages removed. This single-page viewer can be hosted as a static site (e.g. on Amazon S3, Azure Blob Storage, or Github Pages), and easily integrated with existing back-end DICOM storage systems. Alternative [Cornerstone](https://cornerstonejs.org/) Image Loaders can be included to allow your viewer to support non-DICOM objects (e.g. PNG, JPEG).
|
||||
The Standalone Viewer offers only the client-side portions of the OHIF Viewer
|
||||
with the Study List pages removed. This single-page viewer can be hosted as a
|
||||
static site (e.g. on Amazon S3, Azure Blob Storage, or Github Pages), and easily
|
||||
integrated with existing back-end DICOM storage systems. Alternative
|
||||
[Cornerstone](https://cornerstonejs.org/) Image Loaders can be included to allow
|
||||
your viewer to support non-DICOM objects (e.g. PNG, JPEG).
|
||||
@@ -2,6 +2,7 @@
|
||||
id: contributing
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
### I would like to contribute code - how do I do this?
|
||||
@@ -10,27 +11,45 @@ Fork the repository, make your change and submit a pull request.
|
||||
|
||||
### Any guidance on submitting changes?
|
||||
|
||||
While we do appreciate code contributions, triaging and integrating contributed code changes can be very time consuming. Please consider the following tips when working on your pull requests:
|
||||
While we do appreciate code contributions, triaging and integrating contributed
|
||||
code changes can be very time consuming. Please consider the following tips when
|
||||
working on your pull requests:
|
||||
|
||||
- Functionality is appropriate for the repository. Consider posting on the forum if you are not sure.
|
||||
- Code quality is acceptable. We don't have coding standards defined, but make sure it passes ESLint and looks like the rest of the code in the repository.
|
||||
- Quality of design is acceptable. This is a bit subjective so you should consider posting on the forum for specific guidance.
|
||||
- The scope of the pull request is not too large. Please consider separate pull requests for each feature as big pull requests are very time consuming to understand.
|
||||
- Functionality is appropriate for the repository. Consider posting on the forum
|
||||
if you are not sure.
|
||||
- Code quality is acceptable. We don't have coding standards defined, but make
|
||||
sure it passes ESLint and looks like the rest of the code in the repository.
|
||||
- Quality of design is acceptable. This is a bit subjective so you should
|
||||
consider posting on the forum for specific guidance.
|
||||
- The scope of the pull request is not too large. Please consider separate pull
|
||||
requests for each feature as big pull requests are very time consuming to
|
||||
understand.
|
||||
|
||||
We will provide feedback on your pull requests as soon as possible. Following the tips above will help ensure your changes are reviewed.
|
||||
We will provide feedback on your pull requests as soon as possible. Following
|
||||
the tips above will help ensure your changes are reviewed.
|
||||
|
||||
### Testing contribution pull requests
|
||||
|
||||
OHIF uses [netlify](netlify.com) so that pull requests are autogenerated and available for testing.
|
||||
OHIF uses [netlify](https://netlify.com) so that pull requests are autogenerated
|
||||
and available for testing.
|
||||
|
||||
For example, [this url](https://deploy-preview-237--ohif.netlify.com/viewer/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/sampleDICOM.json) allows you to test [pull request 237, the request that created this FAQ entry,](https://github.com/OHIF/Viewers/pull/237) using data pulled from Amazon S3.
|
||||
For example,
|
||||
[this url](https://deploy-preview-237--ohif.netlify.com/viewer/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/sampleDICOM.json)
|
||||
allows you to test
|
||||
[pull request 237, the request that created this FAQ entry,](https://github.com/OHIF/Viewers/pull/237)
|
||||
using data pulled from Amazon S3.
|
||||
|
||||
Replacing the number 237 in the link below with your pull request number should
|
||||
let you test it as well and you can use this link for discussions on github
|
||||
without requiring reviewers to download and build your branch.
|
||||
|
||||
Replacing the number 237 in the link below with your pull request number should let you test it as well and you can use this link for discussions on github without requiring reviewers to download and build your branch.
|
||||
```
|
||||
https://deploy-preview-237--ohif.netlify.com/viewer/?url=https://s3.eu-central-1.amazonaws.com/ohif-viewer/sampleDICOM.json
|
||||
```
|
||||
|
||||
If you have made a documentation change, a link like this will let you preview the gitbook generated by the pull request:
|
||||
If you have made a documentation change, a link like this will let you preview
|
||||
the gitbook generated by the pull request:
|
||||
|
||||
```
|
||||
https://deploy-preview-237--ohif.netlify.com/contributing.html
|
||||
```
|
||||
@@ -54,13 +54,8 @@ proposed collaboration has an impact on cancer research.
|
||||
### Do you offer commercial support?
|
||||
|
||||
The Open Health Imaging Foundation does not offer commercial support, however,
|
||||
some community members do offer consulting services. The following contacts may
|
||||
be useful:
|
||||
|
||||
- Rob Lewis ([Radical Imaging](http://radicalimaging.com/))
|
||||
|
||||
**Please file a Pull Request if you wish to add your name or organization to
|
||||
this list.**
|
||||
some community members do offer consulting services. You can search our
|
||||
[Community Forum](https://community.ohif.org/) for more information.
|
||||
|
||||
### I emailed my question to you directly and you did not respond. Why not?
|
||||
|
||||
|
||||
+57
-33
@@ -1,68 +1,91 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Installation on Windows
|
||||
On Windows, the easiest way to install LesionTracker is using the provided Windows Installer. You can download the latest version of LesionTracker installer from [OHIF](ohif.org)
|
||||
|
||||
On Windows, the easiest way to install LesionTracker is using the provided
|
||||
Windows Installer. You can download the latest version of LesionTracker
|
||||
installer from [OHIF](https://ohif.org)
|
||||
|
||||
## Install
|
||||
|
||||
1. After you have obtained the latest version of LesionTracker installer, double-click the installer to install the application.
|
||||
1. After you have obtained the latest version of LesionTracker installer,
|
||||
double-click the installer to install the application.
|
||||
2. When you start the installer, setup wizard will pop up.
|
||||
|
||||
|
||||
|
||||
|
||||
3. Click **Install** to start the installation.
|
||||
4. LesionTracker will install prerequisites if they do not exist before installing the application.
|
||||
4. LesionTracker will install prerequisites if they do not exist before
|
||||
installing the application.
|
||||
|
||||
|
||||
|
||||
|
||||
5. Click the **Next** if you accept the installation.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Read the license agreement, and if you agree, click **I accept the terms in the License Agreement** and then click the **Next**.
|
||||
6. Read the license agreement, and if you agree, click **I accept the terms in
|
||||
the License Agreement** and then click the **Next**.
|
||||
|
||||
|
||||
|
||||
|
||||
7. Select a location to install LesionTracker and click the **Next** to continue.
|
||||
7. Select a location to install LesionTracker and click the **Next** to
|
||||
continue.
|
||||
|
||||
|
||||
|
||||
|
||||
8. Click the **Install** to start the installation and the installation will be started.
|
||||
8. Click the **Install** to start the installation and the installation will be
|
||||
started.
|
||||
|
||||
|
||||
|
||||
|
||||
9. Click **Finish** to complete the installation.
|
||||
|
||||
|
||||
|
||||
|
||||
10. When the installation is done,
|
||||
* You will see the final dialog which gives the URLs in order to connect to LesionTracker Viewer and Orthanc Server.
|
||||
|
||||
* It will launch computer's default browser and display LesionTracker Viewer if you click 'http://localhost:3000'
|
||||
* It will launch computer's default browser and enables to upload studies to Orthanc Server if you click 'http://localhost:8042'
|
||||
- You will see the final dialog which gives the URLs in order to connect to
|
||||
LesionTracker Viewer and Orthanc Server.
|
||||
|
||||
- It will launch computer's default browser and display LesionTracker Viewer
|
||||
if you click 'http://localhost:3000'
|
||||
- It will launch computer's default browser and enables to upload studies to
|
||||
Orthanc Server if you click 'http://localhost:8042'
|
||||
|
||||
|
||||
|
||||
* Also, LesionTracker installer will create two shortcuts named LesionTracker and Orthanc Server on the Desktop.
|
||||
- Also, LesionTracker installer will create two shortcuts named LesionTracker
|
||||
and Orthanc Server on the Desktop.
|
||||
|
||||
* It will launch computer's default browser and display LesionTracker image viewer if you click LesionTracker application on the Desktop.
|
||||
* It will launch computer's default browser and enables to upload studies to Orthanc Server if you click Orthanc Server application.
|
||||
- It will launch computer's default browser and display LesionTracker image
|
||||
viewer if you click LesionTracker application on the Desktop.
|
||||
- It will launch computer's default browser and enables to upload studies to
|
||||
Orthanc Server if you click Orthanc Server application.
|
||||
|
||||
|
||||
|
||||
11. Click the **Done** and **Close** to close the installation window.
|
||||
|
||||
|
||||
|
||||
|
||||
12. After the installation is completed,
|
||||
* You can find the project folder in C:\Program Files\OHIF\LesionTracker if you use the default installation location.
|
||||
* You will find 4 program executables which eases managing the services in the project folder:
|
||||
|
||||
* **Start Services.exe:** Starts LesionTracker, MongoDB and Orthanc services manually.
|
||||
* **Stop Services.exe:** Stops LesionTracker, MongoDB and Orthanc services manually.
|
||||
* **Turn Off Auto Services.exe:** Configures not to start LesionTracker, MongoDB and Orthanc services automatically when Windows starts up.
|
||||
* **Turn On Auto Services.exe:** Configures to start LesionTracker, MongoDB and Orthanc services automatically when Windows starts up.
|
||||
- You can find the project folder in C:\Program Files\OHIF\LesionTracker if you
|
||||
use the default installation location.
|
||||
- You will find 4 program executables which eases managing the services in the
|
||||
project folder:
|
||||
|
||||
- **Start Services.exe:** Starts LesionTracker, MongoDB and Orthanc services
|
||||
manually.
|
||||
- **Stop Services.exe:** Stops LesionTracker, MongoDB and Orthanc services
|
||||
manually.
|
||||
- **Turn Off Auto Services.exe:** Configures not to start LesionTracker,
|
||||
MongoDB and Orthanc services automatically when Windows starts up.
|
||||
- **Turn On Auto Services.exe:** Configures to start LesionTracker, MongoDB
|
||||
and Orthanc services automatically when Windows starts up.
|
||||
|
||||
|
||||
|
||||
@@ -72,17 +95,18 @@ On Windows, the easiest way to install LesionTracker is using the provided Windo
|
||||
2. Click **Settings**.
|
||||
3. Click **Apps** on the Settings menu.
|
||||
4. Select **Apps & features** from the left panel.
|
||||
5. Find the LesionTracker in programs list and click LesionTracker, then click the **Uninstall**.
|
||||
5. Find the LesionTracker in programs list and click LesionTracker, then click
|
||||
the **Uninstall**.
|
||||
|
||||
|
||||
|
||||
|
||||
6. Click **Uninstall** from the LesionTracker Setup dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
When the uninstallation is done, the uninstallation will remove;
|
||||
|
||||
* Prerequisites: MongoDB, nodejs and Orthanc Server
|
||||
* The project folder, OHIF, from C:\Program Files
|
||||
* Background Services: LesionTracker Server, MongoDB and Orthanc services
|
||||
* Shortcuts: LesionTracker and Orthanc Server shortcuts on the Desktop
|
||||
- Prerequisites: MongoDB, nodejs and Orthanc Server
|
||||
- The project folder, OHIF, from C:\Program Files
|
||||
- Background Services: LesionTracker Server, MongoDB and Orthanc services
|
||||
- Shortcuts: LesionTracker and Orthanc Server shortcuts on the Desktop
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Overview
|
||||
---# Frequently Asked Questions
|
||||
sidebar_label: Overview ---# Frequently Asked Questions
|
||||
---
|
||||
|
||||
## Index
|
||||
|
||||
@@ -38,13 +38,8 @@ proposed collaboration has an impact on cancer research.
|
||||
### Does OHIF offer commercial support?
|
||||
|
||||
The Open Health Imaging Foundation does not offer commercial support, however,
|
||||
some community members do offer consulting services. The following contacts may
|
||||
be useful:
|
||||
|
||||
- Rob Lewis ([Radical Imaging](http://radicalimaging.com/))
|
||||
|
||||
**Please file a Pull Request if you wish to add your name or organization to
|
||||
this list.**
|
||||
some community members do offer consulting services. You can search our
|
||||
[Community Forum](https://community.ohif.org/) for more information.
|
||||
|
||||
### Does The OHIF Viewer have [510(k) Clearance][501k-clearance] from the U.S. F.D.A or [CE Marking][ce-marking] from the European Commission?
|
||||
|
||||
|
||||
@@ -24,12 +24,8 @@ persue paid support.
|
||||
## Commercial Support
|
||||
|
||||
The Open Health Imaging Foundation does not offer commercial support, however,
|
||||
some community members do offer consulting services:
|
||||
|
||||
- Rob Lewis ([Radical Imaging](http://radicalimaging.com/))
|
||||
|
||||
**Please file a Pull Request if you wish to add your name or organization to
|
||||
this list.**
|
||||
some community members do offer consulting services. You can search our
|
||||
[Community Forum](https://community.ohif.org/) for more information.
|
||||
|
||||
<!--
|
||||
Links
|
||||
|
||||
Reference in new issue
Block a user