Add setup.py file

.gitignore

@@ -128,3 +128,4 @@ dmypy.json
 # Pyre type checker
 .pyre/
 /data/
+/venv-test/

README.md

@@ -7,13 +7,28 @@ ground-based observations. These codes were presented in the article
 'Removing cloud shadows from ground-based solar imagery, Chaoui et
 al.'
 
+## Install
+
+You can pip install directly from this github repo:
+
+```bash
+pip install git+https://github.com/jaypmorgan/cloud-removal.git
+```
+
+or if you've cloned the repo to a local directory:
+
+```bash
+cd cloudremoval
+pip install ./
+```
+
 ## Usage
 
-Using the existing synthetic dataset:
+Using the existing synthetic clouds dataset:
 
 ```python
 import dfp
-from src.dataset import SyntheticClouds, CloudsTransform
+from cloudremoval.dataset import SyntheticClouds, CloudsTransform
 
 # download the data
 dataset = SyntheticClouds(download=True)
@@ -39,7 +54,7 @@ inp2 = item.input
 To create a model, or load one using existing model weights:
 
 ```python
-from src.model import CloudRemover
+from cloudremoval.model import CloudRemover
 
 # create a new model from scratch (i.e. random model weights)
 model = CloudRemover()

requirements.txt

 sunpy
 dfp
 numpy
-pandas
+pandas==1.*
 torch
 torchvision
 matplotlib

setup.py

+from distutils.core import setup
+
+with open("requirements.txt") as f:
+    required_packages = f.read().splitlines()
+
+setup(
+    name="cloudremoval",
+    version="1.0",
+    description="Cloud removal from ground-based imaging",
+    author="Jay Paul Morgan",
+    author_email="jay.morgan@univ-tln.fr",
+    url="https://github.com/jaypmorgan/cloud-removal",
+    packages=["cloudremoval"],
+    package_dir={"cloudremoval": "src/cloudremoval"},
+    install_requires=required_packages)

src/cloudremoval/__init__.py

+from . import model
+from . import dataset

tests/test_dataset.py

 import dfp
-from src.dataset import SyntheticClouds, CloudsTransform
+from cloudremoval.dataset import SyntheticClouds, CloudsTransform
 
 # download the data
 dataset = SyntheticClouds(download=True)

tests/test_model.py

-from src.model import CloudRemover
+from cloudremoval.model import CloudRemover
 
 # create a model
 model = CloudRemover()