223 lines
10 KiB
Markdown
223 lines
10 KiB
Markdown
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<div align="center">
|
|
<h1>OHIF prod-ab branch</h1>
|
|
<p>Branch prod-ab adalah OHIF dari PT. SIM yang siap untuk digunakan versi production saat ini.</p>
|
|
</div>
|
|
|
|
|
|
<div align="center">
|
|
<a href="https://docs.ohif.org/"><strong>Read The Docs</strong></a>
|
|
</div>
|
|
<div align="center">
|
|
<a href="https://viewer.ohif.org/">Live Demo</a> |
|
|
<a href="https://ui.ohif.org/">Component Library</a>
|
|
</div>
|
|
|
|
<hr />
|
|
|
|
## Developing
|
|
|
|
### Requirements
|
|
|
|
- [Yarn 1.17.3+](https://yarnpkg.com/en/docs/install)
|
|
- [Node 18+](https://nodejs.org/en/)
|
|
- Yarn Workspaces should be enabled on your machine:
|
|
- `yarn config set workspaces-experimental true`
|
|
|
|
### Getting Started
|
|
|
|
1. Clone the repository
|
|
- `git clone https://github.com/OHIF/Viewers.git`
|
|
2. Navigate to the cloned project's directory
|
|
3. `yarn install` to restore dependencies and link projects
|
|
4. `yarn dev` to start the development server
|
|
|
|
#### To Develop
|
|
|
|
_From this repository's root directory:_
|
|
|
|
```bash
|
|
# Enable Yarn Workspaces
|
|
yarn config set workspaces-experimental true
|
|
|
|
# Restore dependencies
|
|
yarn install
|
|
|
|
# Run with hot-reload
|
|
yarn run dev
|
|
```
|
|
|
|
## Commands
|
|
|
|
These commands are available from the root directory. Each project directory
|
|
also supports a number of commands that can be found in their respective
|
|
`README.md` and `package.json` files.
|
|
|
|
| Commands | Description |
|
|
| ---------------------------- | ------------------------------------------------------------- |
|
|
| **Develop** | |
|
|
| `dev` or `start` | Default development experience for Viewer |
|
|
| `test:unit` | Jest multi-project test runner; overall coverage |
|
|
| **Deploy** | |
|
|
| `build`\* | Builds production output for our PWA Viewer | |
|
|
|
|
\* - For more information on our different builds, check out our [Deploy
|
|
Docs][deployment-docs]
|
|
|
|
## Project
|
|
|
|
The OHIF Medical Image Viewing Platform is maintained as a
|
|
[`monorepo`][monorepo]. This means that this repository, instead of containing a
|
|
single project, contains many projects. If you explore our project structure,
|
|
you'll see the following:
|
|
|
|
```bash
|
|
.
|
|
├── extensions #
|
|
│ ├── _example # Skeleton of example extension
|
|
│ ├── default # basic set of useful functionalities (datasources, panels, etc)
|
|
│ ├── cornerstone # image rendering and tools w/ Cornerstone3D
|
|
│ ├── cornerstone-dicom-sr # DICOM Structured Report rendering and export
|
|
│ ├── cornerstone-dicom-sr # DICOM Structured Report rendering and export
|
|
│ ├── cornerstone-dicom-seg # DICOM Segmentation rendering and export
|
|
│ ├── cornerstone-dicom-rt # DICOM RTSTRUCT rendering
|
|
│ ├── cornerstone-microscopy # Whole Slide Microscopy rendering
|
|
│ ├── dicom-pdf # PDF rendering
|
|
│ ├── dicom-video # DICOM RESTful Services
|
|
│ ├── measurement-tracking # Longitudinal measurement tracking
|
|
│ ├── tmtv # Total Metabolic Tumor Volume (TMTV) calculation
|
|
|
|
|
|
|
│
|
|
├── modes #
|
|
│ ├── _example # Skeleton of example mode
|
|
│ ├── basic-dev-mode # Basic development mode
|
|
│ ├── longitudinal # Longitudinal mode (measurement tracking)
|
|
│ ├── tmtv # Total Metabolic Tumor Volume (TMTV) calculation mode
|
|
│ └── microscopy # Whole Slide Microscopy mode
|
|
│
|
|
├── platform #
|
|
│ ├── core # Business Logic
|
|
│ ├── i18n # Internationalization Support
|
|
│ ├── ui # React component library
|
|
│ ├── docs # Documentation
|
|
│ └── viewer # Connects platform and extension projects
|
|
│
|
|
├── ... # misc. shared configuration
|
|
├── lerna.json # MonoRepo (Lerna) settings
|
|
├── package.json # Shared devDependencies and commands
|
|
└── README.md # This file
|
|
```
|
|
|
|
## Acknowledgments
|
|
|
|
To acknowledge the OHIF Viewer in an academic publication, please cite
|
|
|
|
> _Open Health Imaging Foundation Viewer: An Extensible Open-Source Framework
|
|
> for Building Web-Based Imaging Applications to Support Cancer Research_
|
|
>
|
|
> Erik Ziegler, Trinity Urban, Danny Brown, James Petts, Steve D. Pieper, Rob
|
|
> Lewis, Chris Hafey, and Gordon J. Harris
|
|
>
|
|
> _JCO Clinical Cancer Informatics_, no. 4 (2020), 336-345, DOI:
|
|
> [10.1200/CCI.19.00131](https://www.doi.org/10.1200/CCI.19.00131)
|
|
>
|
|
> Open-Access on Pubmed Central:
|
|
> https://www.ncbi.nlm.nih.gov/pmc/articles/PMC7259879/
|
|
|
|
or, for v1, please cite:
|
|
|
|
> _LesionTracker: Extensible Open-Source Zero-Footprint Web Viewer for Cancer
|
|
> Imaging Research and Clinical Trials_
|
|
>
|
|
> Trinity Urban, Erik Ziegler, Rob Lewis, Chris Hafey, Cheryl Sadow, Annick D.
|
|
> Van den Abbeele and Gordon J. Harris
|
|
>
|
|
> _Cancer Research_, November 1 2017 (77) (21) e119-e122 DOI:
|
|
> [10.1158/0008-5472.CAN-17-0334](https://www.doi.org/10.1158/0008-5472.CAN-17-0334)
|
|
|
|
**Note:** If you use or find this repository helpful, please take the time to
|
|
star this repository on GitHub. This is an easy way for us to assess adoption
|
|
and it can help us obtain future funding for the project.
|
|
|
|
This work is supported primarily by the National Institutes of Health, National
|
|
Cancer Institute, Informatics Technology for Cancer Research (ITCR) program,
|
|
under a
|
|
[grant to Dr. Gordon Harris at Massachusetts General Hospital (U24 CA199460)](https://projectreporter.nih.gov/project_info_description.cfm?aid=8971104).
|
|
|
|
[NCI Imaging Data Commons (IDC) project](https://imaging.datacommons.cancer.gov/) supported the development of new features and bug fixes marked with ["IDC:priority"](https://github.com/OHIF/Viewers/issues?q=is%3Aissue+is%3Aopen+label%3AIDC%3Apriority),
|
|
["IDC:candidate"](https://github.com/OHIF/Viewers/issues?q=is%3Aissue+is%3Aopen+label%3AIDC%3Acandidate) or ["IDC:collaboration"](https://github.com/OHIF/Viewers/issues?q=is%3Aissue+is%3Aopen+label%3AIDC%3Acollaboration). NCI Imaging Data Commons is supported by contract number 19X037Q from
|
|
Leidos Biomedical Research under Task Order HHSN26100071 from NCI. [IDC Viewer](https://learn.canceridc.dev/portal/visualization) is a customized version of the OHIF Viewer.
|
|
|
|
This project is tested with BrowserStack. Thank you for supporting open-source!
|
|
|
|
## License
|
|
|
|
MIT © [OHIF](https://github.com/OHIF)
|
|
|
|
<!--
|
|
Links
|
|
-->
|
|
|
|
<!-- prettier-ignore-start -->
|
|
<!-- Badges -->
|
|
[lerna-image]: https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg
|
|
[lerna-url]: https://lerna.js.org/
|
|
[netlify-image]: https://api.netlify.com/api/v1/badges/32708787-c9b0-4634-b50f-7ca41952da77/deploy-status
|
|
[netlify-url]: https://app.netlify.com/sites/ohif-dev/deploys
|
|
[all-contributors-image]: https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square
|
|
[circleci-image]: https://circleci.com/gh/OHIF/Viewers.svg?style=svg
|
|
[circleci-url]: https://circleci.com/gh/OHIF/Viewers
|
|
[codecov-image]: https://codecov.io/gh/OHIF/Viewers/branch/master/graph/badge.svg
|
|
[codecov-url]: https://codecov.io/gh/OHIF/Viewers/branch/master
|
|
[prettier-image]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square
|
|
[prettier-url]: https://github.com/prettier/prettier
|
|
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
|
|
[semantic-url]: https://github.com/semantic-release/semantic-release
|
|
<!-- ROW -->
|
|
[npm-url]: https://npmjs.org/package/@ohif/app
|
|
[npm-downloads-image]: https://img.shields.io/npm/dm/@ohif/app.svg?style=flat-square
|
|
[npm-version-image]: https://img.shields.io/npm/v/@ohif/app.svg?style=flat-square
|
|
[docker-pulls-img]: https://img.shields.io/docker/pulls/ohif/viewer.svg?style=flat-square
|
|
[docker-image-url]: https://hub.docker.com/r/ohif/app
|
|
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
|
|
[license-url]: LICENSE
|
|
[percy-image]: https://percy.io/static/images/percy-badge.svg
|
|
[percy-url]: https://percy.io/Open-Health-Imaging-Foundation/OHIF-Viewer
|
|
<!-- Links -->
|
|
[monorepo]: https://en.wikipedia.org/wiki/Monorepo
|
|
[how-to-fork]: https://help.github.com/en/articles/fork-a-repo
|
|
[how-to-clone]: https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork
|
|
[ohif-architecture]: https://docs.ohif.org/architecture/index.html
|
|
[ohif-extensions]: https://docs.ohif.org/architecture/index.html
|
|
[deployment-docs]: https://docs.ohif.org/deployment/
|
|
[react-url]: https://reactjs.org/
|
|
[pwa-url]: https://developers.google.com/web/progressive-web-apps/
|
|
[ohif-viewer-url]: https://www.npmjs.com/package/@ohif/app
|
|
[configuration-url]: https://docs.ohif.org/configuring/
|
|
[extensions-url]: https://docs.ohif.org/extensions/
|
|
<!-- Platform -->
|
|
[platform-core]: platform/core/README.md
|
|
[core-npm]: https://www.npmjs.com/package/@ohif/core
|
|
[platform-i18n]: platform/i18n/README.md
|
|
[i18n-npm]: https://www.npmjs.com/package/@ohif/i18n
|
|
[platform-ui]: platform/ui/README.md
|
|
[ui-npm]: https://www.npmjs.com/package/@ohif/ui
|
|
[platform-viewer]: platform/app/README.md
|
|
[viewer-npm]: https://www.npmjs.com/package/@ohif/app
|
|
<!-- Extensions -->
|
|
[extension-cornerstone]: extensions/cornerstone/README.md
|
|
[cornerstone-npm]: https://www.npmjs.com/package/@ohif/extension-cornerstone
|
|
[extension-dicom-html]: extensions/dicom-html/README.md
|
|
[html-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-html
|
|
[extension-dicom-microscopy]: extensions/dicom-microscopy/README.md
|
|
[microscopy-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-microscopy
|
|
[extension-dicom-pdf]: extensions/dicom-pdf/README.md
|
|
[pdf-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-pdf
|
|
[extension-vtk]: extensions/vtk/README.md
|
|
[vtk-npm]: https://www.npmjs.com/package/@ohif/extension-vtk
|
|
<!-- prettier-ignore-end -->
|
|
|
|
[](https://app.fossa.com/projects/git%2Bgithub.com%2FOHIF%2FViewers?ref=badge_large&issueType=license)
|