|
@@ -1,7 +1,26 @@
|
|
|
-# Project <insert name>
|
|
|
+# Highspeed Masks
|
|
|
|
|
|
-## Dataset structure
|
|
|
+## Description
|
|
|
|
|
|
-- All inputs (i.e. building blocks from other sources) are located in
|
|
|
- `inputs/`.
|
|
|
-- All custom code is located in `code/`.
|
|
|
+This repository contains binarized anatomical masks used in Wittkuhn & Schuck, 2020, *Nature Communications*.
|
|
|
+
|
|
|
+Please visit the project website at https://wittkuhn.mpib.berlin/highspeed.
|
|
|
+
|
|
|
+## Usage
|
|
|
+
|
|
|
+### Get data
|
|
|
+
|
|
|
+
|
|
|
+### Run code
|
|
|
+
|
|
|
+Install required packages:
|
|
|
+
|
|
|
+```bash
|
|
|
+mkvirtualenv -p $(which python3) highspeed-masks
|
|
|
+pip install -r requirements.txt
|
|
|
+```
|
|
|
+
|
|
|
+## Contact
|
|
|
+
|
|
|
+- [Lennart Wittkuhn](mailto:wittkuhn@mpib-berlin.mpg.de)
|
|
|
+- [Nicolas W. Schuck](mailto:schuck@mpib-berlin.mpg.de)
|