Show example usage in the README

README.md

@@ -4,3 +4,84 @@
 [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)  
 [![pip - Build, Lint, Test, and Coverage](https://github.com/B612-Asteroid-Institute/adam_test_data/actions/workflows/pip-build-lint-test-coverage.yml/badge.svg)](https://github.com/B612-Asteroid-Institute/adam_test_data/actions/workflows/pip-build-lint-test-coverage.yml)
 
+## Installation
+
+`adam_test_data` can currently be install from source via pdm:
+
+```pdm install```
+
+## Usage
+
+Loading in population models:
+
+```python
+from adam_test_data.datasets import load_S3M
+from adam_test_data.datasets import load_P9
+
+S3M_DIR = "S3M_v09.05.15"
+P9_DIR = "P9"
+
+S3M = load_S3M(S3M_DIR)
+P9 = load_P9(P9_DIR)
+```
+
+Loading in a pointing table for a survey or telescope. Here we create one for NSC DR2:
+
+```python
+from adam_test_data.observatory import Observatory, Simulation, FieldOfView
+from adam_test_data.pointings import Pointings
+
+
+w84 = Observatory(
+    code="W84",
+    filters=["u", "g", "r", "i", "z", "Y", "VR"],
+    main_filter="r",
+    bright_limit=[15.0,15.0,15.0,15.0,15.0,15.0,15.0],
+    fov=FieldOfView(
+        camera_model="circle",
+        circle_radius=1.1,
+        fill_factor=0.9
+    ),
+    simulation=Simulation(
+        ang_fov=2.5,
+        fov_buffer=0.1
+    )
+)
+
+
+nsc_dr2_exposures = pd.read_csv("nsc_dr2_exposure.csv")
+nsc_dr2_exposures["depth5sig"] = nsc_dr2_exposures["depth95"]
+nsc_dr2_exposures_w84 = nsc_dr2_exposures[nsc_dr2_exposures["instrument"] == "c4d"]
+
+w84_pointings = Pointings.from_kwargs(
+    observationId=nsc_dr2_exposures_w84["exposure"],
+    observationStartMJD_TAI=Time(nsc_dr2_exposures_w84["mjd"], format="mjd", scale="utc").tai.mjd,
+    visitTime=nsc_dr2_exposures_w84["exptime"],
+    visitExposureTime=nsc_dr2_exposures_w84["exptime"],
+    filter=nsc_dr2_exposures_w84["filter"],
+    seeingFwhmGeom_arcsec=nsc_dr2_exposures_w84["fwhm"],
+    seeingFwhmEff_arcsec=nsc_dr2_exposures_w84["fwhm"],
+    fieldFiveSigmaDepth_mag=nsc_dr2_exposures_w84["depth5sig"],
+    fieldRA_deg=nsc_dr2_exposures_w84["ra"],
+    fieldDec_deg=nsc_dr2_exposures_w84["dec"],
+    rotSkyPos_deg=np.zeros(len(nsc_dr2_exposures_w84)),
+    observatory_code=pa.repeat("W84", len(nsc_dr2_exposures_w84)),
+    name="NSC",
+)
+```
+
+Generate test data for one of the populations and one of the observatories:
+```python
+from adam_test_data.main import generate_test_data
+
+catalog_file, noise_files, summary = generate_test_data(
+    "S3M_NSC_W84", 
+    s3m, 
+    w84_pointings, 
+    w84, 
+    noise_densities=[100, 200], 
+    max_processes=30, 
+    chunk_size=500, 
+    cleanup=True
+)
+```