From 15a256beed12c41dda890cfcd66e458a8256cfb5 Mon Sep 17 00:00:00 2001
From: KatrionaGoldmann <kgoldmann@turing.ac.uk>
Date: Thu, 1 Aug 2024 15:55:52 +0100
Subject: [PATCH] populate README

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index 0ece3ad..f10ae4a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
 # object-store-scripts
 
+Directory to download images from Jasmin object store and perform inference to:
+- detect objects
+- classify objects as moth or non-moth
+- identify the order
+- determine the moth species
+
+## Installation
+
+To install the required packages, run the following command:
+
+```bash
+pip install -r requirements.txt
+```
+
+## Usage
+
+To run the script, use the following command:
+
+```bash
+python s3_download_with_inference.py \
+  --country "Costa Rica" \
+  --deployment "Forest Edge - EC4AB109" \
+  --keep_crops
+```
+
+Or to run on baskerville:
+
+```bash
+sbatch cr_analysis.sh
+```
+
+
+To download interactively, and without inference and subsequent image deletion:
+
+```bash
+python s3_download_async.py
+```