523 lines
18 KiB
HTML
523 lines
18 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>Getting Started · OHIF</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.3">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-anchors/plugin.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-theme-cornerstone/cornerstone.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="troubleshooting.html" />
|
|
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.2" >
|
|
|
|
<span>
|
|
|
|
|
|
Documentation Version
|
|
|
|
</span>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3" >
|
|
|
|
<span>
|
|
|
|
|
|
Essentials
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter active" data-level="1.3.1" data-path="getting-started.html">
|
|
|
|
<a href="getting-started.html">
|
|
|
|
|
|
Getting Started
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.3.2" data-path="troubleshooting.html">
|
|
|
|
<a href="troubleshooting.html">
|
|
|
|
|
|
Troubleshooting
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="1.4" >
|
|
|
|
<span>
|
|
|
|
|
|
Connecting to Image Archives
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="1.4.1" data-path="../connecting-to-image-archives/dicomweb.html">
|
|
|
|
<a href="../connecting-to-image-archives/dicomweb.html">
|
|
|
|
|
|
DICOM Web
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" >
|
|
|
|
<span>
|
|
|
|
|
|
I Want To
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="2.1.1" data-path="../I-want-to/script-tag.html">
|
|
|
|
<a href="../I-want-to/script-tag.html">
|
|
|
|
|
|
Embed the viewer using a script tag
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="3.1" >
|
|
|
|
<span>
|
|
|
|
|
|
FAQ
|
|
|
|
</span>
|
|
|
|
|
|
|
|
<ul class="articles">
|
|
|
|
|
|
<li class="chapter " data-level="3.1.1" data-path="../faq/general.html">
|
|
|
|
<a href="../faq/general.html">
|
|
|
|
|
|
General
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="4.1" data-path="../contributing.html">
|
|
|
|
<a href="../contributing.html">
|
|
|
|
|
|
Contributing
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >Getting Started</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<h1 id="getting-started"><a name="getting-started" class="plugin-anchor" href="#getting-started"><i class="fa fa-link" aria-hidden="true"></i></a>Getting Started</h1>
|
|
<h2 id="getting-the-code"><a name="getting-the-code" class="plugin-anchor" href="#getting-the-code"><i class="fa fa-link" aria-hidden="true"></i></a>Getting the Code</h2>
|
|
<p>Either clone the repository using Git:</p>
|
|
<pre><code class="lang-bash">git <span class="hljs-built_in">clone</span> git@github.com:OHIF/Viewers.git
|
|
</code></pre>
|
|
<p>or <a href="https://github.com/OHIF/Viewers/archive/master.zip" target="_blank">Download the latest Master as a ZIP File</a>.</p>
|
|
<h2 id="test-the-archive-against-our-public-dicom-server"><a name="test-the-archive-against-our-public-dicom-server" class="plugin-anchor" href="#test-the-archive-against-our-public-dicom-server"><i class="fa fa-link" aria-hidden="true"></i></a>Test the archive against our public DICOM server</h2>
|
|
<h2 id="set-up-and-test-the-ohif-viewer-application"><a name="set-up-and-test-the-ohif-viewer-application" class="plugin-anchor" href="#set-up-and-test-the-ohif-viewer-application"><i class="fa fa-link" aria-hidden="true"></i></a>Set up and test the OHIF Viewer application:</h2>
|
|
<ol>
|
|
<li><a href="https://nodejs.org/en/" target="_blank">Install Node.js</a></li>
|
|
<li><p>Open a new terminal tab in the <code>ohif-viewer</code> directory and install all dependency packages via NPM</p>
|
|
<pre><code class="lang-bash"><span class="hljs-built_in">cd</span> Packages-react/ohif-viewer
|
|
npm install
|
|
</code></pre>
|
|
</li>
|
|
<li><p>Run the application</p>
|
|
<pre><code class="lang-bash">npm start
|
|
</code></pre>
|
|
</li>
|
|
</ol>
|
|
<p>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.</p>
|
|
<ol>
|
|
<li>Launch the OHIF Viewer Study List by visiting <a href="http://localhost:3000/" target="_blank">http://localhost:3000/</a> in a web browser.</li>
|
|
</ol>
|
|
<p><strong>If everything is working correctly, you should see the studies from our public archive when you visit the Study List.</strong></p>
|
|
<ol>
|
|
<li><p>Double-click on a Study in the Study List to launch it in the Viewer</p>
|
|
<p><strong>If everything is working correctly, you should see your study load into the Viewer.</strong></p>
|
|
</li>
|
|
</ol>
|
|
<h2 id="set-up-a-local-dicom-server"><a name="set-up-a-local-dicom-server" class="plugin-anchor" href="#set-up-a-local-dicom-server"><i class="fa fa-link" aria-hidden="true"></i></a>Set up a local DICOM server</h2>
|
|
<ol>
|
|
<li>Choose and install an Image Archive</li>
|
|
<li>Upload some data into your archive (e.g. with DCMTK's <a href="http://support.dcmtk.org/docs/storescu.html" target="_blank">storescu</a> or your archive's web interface)</li>
|
|
<li>Keep the server running</li>
|
|
</ol>
|
|
<h4 id="open-source-dicom-image-archive-options"><a name="open-source-dicom-image-archive-options" class="plugin-anchor" href="#open-source-dicom-image-archive-options"><i class="fa fa-link" aria-hidden="true"></i></a>Open Source DICOM Image Archive Options</h4>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Archive</th>
|
|
<th>Installation</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a href="https://github.com/dcm4che/dcm4chee-arc-light" target="_blank">DCM4CHEE Archive 5.x</a></td>
|
|
<td><a href="https://github.com/dcm4che/dcm4chee-arc-light/wiki/Running-on-Docker" target="_blank">Installation with Docker</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://www.orthanc-server.com/" target="_blank">Orthanc</a></td>
|
|
<td><a href="http://book.orthanc-server.com/users/docker.html" target="_blank">Installation with Docker</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://github.com/DICOMcloud/DICOMcloud" target="_blank">DICOMcloud</a> (<strong>DICOM Web only</strong>)</td>
|
|
<td><a href="https://github.com/DICOMcloud/DICOMcloud#running-the-code" target="_blank">Installation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="http://www.osirix-viewer.com/" target="_blank">OsiriX</a> (<strong>Mac OSX only</strong>)</td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a href="https://www.horosproject.org/" target="_blank">Horos</a> (<strong>Mac OSX only</strong>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><em>Feel free to make a Pull Request if you want to add to this list.</em></p>
|
|
<h2 id="set-up-and-test-the-ohif-viewer-application"><a name="set-up-and-test-the-ohif-viewer-application" class="plugin-anchor" href="#set-up-and-test-the-ohif-viewer-application"><i class="fa fa-link" aria-hidden="true"></i></a>Set up and test the OHIF Viewer application:</h2>
|
|
<ol>
|
|
<li><a href="https://nodejs.org/en/" target="_blank">Install Node.js</a></li>
|
|
<li><p>Open a new terminal tab in the <code>ohif-viewer</code> directory and install all dependency packages via NPM</p>
|
|
<pre><code class="lang-bash"><span class="hljs-built_in">cd</span> Packages-react/ohif-viewer
|
|
npm install
|
|
</code></pre>
|
|
</li>
|
|
<li><p>Run the application using one of the available configuration files.</p>
|
|
<pre><code class="lang-bash">REACT_APP_CONFIG=$(cat ../../config-react/ccc.json)
|
|
npm start
|
|
</code></pre>
|
|
<p>This uses the <a href="https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables" target="_blank">Custom Environment Variables of Create-React-App</a> 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.</p>
|
|
</li>
|
|
<li><p>Launch the OHIF Viewer Study List by visiting <a href="http://localhost:3000/" target="_blank">http://localhost:3000/</a> in a web browser.</p>
|
|
<p><strong>If everything is working correctly, you should see the Study List from your archive when you visit the Study List.</strong></p>
|
|
</li>
|
|
<li><p>Double-click on a Study in the Study List to launch it in the Viewer</p>
|
|
<p><strong>If everything is working correctly, you should see your study load into the Viewer.</strong></p>
|
|
</li>
|
|
</ol>
|
|
<h4 id="troubleshooting"><a name="troubleshooting" class="plugin-anchor" href="#troubleshooting"><i class="fa fa-link" aria-hidden="true"></i></a>Troubleshooting</h4>
|
|
<ul>
|
|
<li>If you receive a <em>"No Studies Found"</em> message and do not see your studies, try changing the Study Date filters to a wider range.</li>
|
|
<li>If you see a 'Loading' message which never resolves, check your browser JavaScript console inside the Developer Tools to identify any errors.</li>
|
|
<li>If you see any errors in your server console, check the <a href="../troubleshooting.md">Troubleshooting</a> page for more in depth advice.</li>
|
|
</ul>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a href="troubleshooting.html" class="navigation navigation-next navigation-unique" aria-label="Next page: Troubleshooting">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"Getting Started","level":"1.3.1","depth":2,"next":{"title":"Troubleshooting","level":"1.3.2","depth":2,"path":"essentials/troubleshooting.md","ref":"essentials/troubleshooting.md","articles":[]},"previous":{"title":"Essentials","level":"1.3","depth":1,"ref":"","articles":[{"title":"Getting Started","level":"1.3.1","depth":2,"path":"essentials/getting-started.md","ref":"essentials/getting-started.md","articles":[]},{"title":"Troubleshooting","level":"1.3.2","depth":2,"path":"essentials/troubleshooting.md","ref":"essentials/troubleshooting.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["edit-link","theme-cornerstone","-fontsettings","github","ga","sitemap","anchors"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"github":{"url":"https://github.com/OHIF/Viewers"},"search":{},"theme-cornerstone":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"highlight":{},"sitemap":{"hostname":"https://docs.ohif.org"},"ga":{"configuration":"auto","token":"UA-110573590-2"},"versions":{"gitbookConfigURL":"https://raw.githubusercontent.com/OHIF/Viewers/master/docs/book.json","options":[{"value":"https://docs.ohif.org/history/v1/","text":"Version 1.0.0 (Meteor)"},{"value":"https://docs.ohif.org/","text":"Version 2.0.0","selected":true}]},"sharing":{"facebook":false,"twitter":false,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/OHIF/Viewers/edit/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchors":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OHIF","links":{"sharing":{"facebook":false,"twitter":false}},"gitbook":">3.0.0","description":"Documentation for the OHIF framework"},"file":{"path":"essentials/getting-started.md","mtime":"2019-03-04T09:16:35.329Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2019-03-04T11:49:18.871Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-edit-link/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-github/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-ga/plugin.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|