added README; running only notebooks in CI

.github/workflows/ci.yml

@@ -52,11 +52,3 @@ jobs:
           jupyter nbconvert --to script *.ipynb --output-dir .
           for f in *.py; do python "$f"; done
         working-directory: ./notebooks
-
-      - name: Preprocess Data
-        run: |
-          python scripts/preprocess.py
-
-      - name: Train Model
-        run: |
-          python scripts/train.py

README.md

@@ -0,0 +1,14 @@
+DeepMap code for DL on historical Aerial Images
+-----------------------------------------------
+
+The `notebooks/` folder contains sample exploratory code to get familiar with libraries and APIs for GIS.
+The `scripts/` folder contains the preprocessing and training code for the DeepMap model.
+
+### Installation
+
+`pip install .` should work, though due to latest `importlib.resources` not supporting directories,
+you may need to install the package in editable mode (`pip install -e .`) to run scripts in the `scripts/` folder.
+
+### Data
+
+Sample data is included in the `deepmap.data` module. Larger data files are download on demand using the `deepmap.data.ondemand.get_file` function.