Skip to content

Commit 973761e

Browse files
author
hackermd
committed
Add first simple test
1 parent 219af5f commit 973761e

File tree

6 files changed

+2437
-208
lines changed

6 files changed

+2437
-208
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Web-based viewer for [DICOM Visible Light Whole Slide Microscopy Images](http://
44

55
## Install
66

7-
The `dicom-microscopy-viewer` package can be installed via [npm](https://www.npmjs.com/):
7+
The [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package can be installed via `npm` package manager:
88

99
```None
1010
npm install dicom-microscopy-viewer
@@ -21,6 +21,17 @@ npm install
2121
npm run build
2222
```
2323

24+
## Test
25+
26+
The library can be tested locally with [mochify](https://github.com/mantoni/mochify.js) (using [mocha](https://mochajs.org/) and [chai](http://www.chaijs.com/)):
27+
28+
```None
29+
git clone https://github.com/dcmjs-org/dicom-microscopy-viewer ~/dicom-microscopy-viewer
30+
cd ~/dicom-microscopy-viewer
31+
npm install
32+
npm test
33+
```
34+
2435
## Usage
2536

2637
```js
@@ -41,13 +52,13 @@ viewer.render({container: "viewport"});
4152
**This is work-in-progress and should not be used in clinical practice.**
4253

4354
The viewer allows visualization of *VL Whole Slide Microscopy Image* datasets stored in a [DICOMweb](https://www.dicomstandard.org/dicomweb/) compatible archive.
44-
It leverages [dicomweb-client](https://github.com/dcmjs-org/dicomweb-client) to retrieve data from the archive.
55+
It leverages the [dicomweb-client](https://github.com/dcmjs-org/dicomweb-client) JavaScript library to retrieve data from the archive.
4556

4657
### Limitations
4758

4859
Currently, the viewer only supports
4960

50-
* baseline JPEG with transfer syntax "1.2.840.10008.1.2.4.50"
61+
* baseline JPEG compressed data (transfer syntax "1.2.840.10008.1.2.4.50")
5162
* brightfield illumination (no fluorescence)
5263
* 2D images (no z-stacks)
5364

mocha.opts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
--require should
2+
--reporter dot
3+
--ui bdd

0 commit comments

Comments
 (0)