Skip to content

Commit

Permalink
More info in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pieper committed Feb 7, 2020
1 parent 69ec5da commit 184cf07
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# data
A repository that can be used to attach anonymized data for testing

## usage

The github releases feature for this repository is used to present binary datasets that can be easily downloaded for use in testing.

For example this command downloads a single series of an MR scan:
```
curl -L "https://github.com/dcmjs-org/data/releases/download/MRHead/MRHead.zip" > MRHead.zip
```

If you have comments or questions about the data, such as how the data is encoded or what the fields mean, please open an issue on this repository and reference the particular dataset.

## contributing

Make abolutely sure you can share the data according to any applicable regulations (e.g. policies of your employer or government). Also be sure you are comfortable sharing the data with the general pubic because it may get used for purposes over which you have no control.

To share:
* You need to join this repository, which means getting to know one of the dcmjs-org organization owners well enough that they trust you to contribute data legitimately
* Create a new release on this repository
* Attach the data (e.g. drag and drop a zip file)
* Provide an informative description

0 comments on commit 184cf07

Please sign in to comment.