rename package

nonnontrivial · May 2, 2024 · 413d9dd · 413d9dd
1 parent fe3e5f8
commit 413d9dd
Show file tree

Hide file tree

Showing 54 changed files with 292,862 additions and 69 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,4 +10,3 @@ __pycache__/
 data/globe_at_night/*.csv
 
 prediction/*.csv
-validation/*.csv
diff --git a/.idea/ctts.iml b/.idea/ctts.iml
diff --git a/README.md b/README.md
@@ -1,64 +0,0 @@
-# CTTS
-
-APIs that tap into the quality of the night sky.
-
-## Building and training the sky brightness model
-
-> Note that `globe_at_night.tar.gz` will need to unpacked into `./data/globe_at_night`
-
-- `python -m ctts.model.build` to write the csv that the model trains on
-- `python -m ctts.model.train` to train on the data in the csv
-
-## HTTP APIs
-
-### how to run locally
-
-> Note: tested on python 3.11
-
-```sh
-pip install -r requirements.txt
-python -m uvicorn ctts.api:app --reload
-```
-
-- artificial sky brightness (light pollution)
-- predictive sky brightness
-
-### endpoints
-
-#### `/api/v1/pollution`
-
-Gets the approximate artificial sky brightness
-map [RGBA pixel value](https://djlorenz.github.io/astronomy/lp2022/colors.html) for a lat and lon (for the year 2022).
-
-```sh
-curl "localhost:8000/api/v1/pollution?lat=40.7277478&lon=-74.0000374"
-```
-
-```json
-{
-  "r": 255,
-  "g": 255,
-  "b": 255,
-  "a": 255
-}
-```
-
-#### `/api/v1/prediction`
-
-Gets the predicted sky brightness at `lat` and `lon` for the current time.
-
-```sh
-curl "http://localhost:8000/api/v1/prediction?lat=-30.2466&lon=-70.7494"
-
-```
-
-```json
-{
-  "sky_brightness": 22.0388
-}
-```
-
-### swagger ui
-
-Open the [ui](http://localhost:8000/docs) in a browser.
-

diff --git a/.dockerignore → api/.dockerignore b/.dockerignore → api/.dockerignore
diff --git a/api/.idea/.gitignore b/api/.idea/.gitignore
diff --git a/api/.idea/api.iml b/api/.idea/api.iml
diff --git a/api/.idea/inspectionProfiles/profiles_settings.xml b/api/.idea/inspectionProfiles/profiles_settings.xml
diff --git a/api/.idea/misc.xml b/api/.idea/misc.xml
diff --git a/api/.idea/modules.xml b/api/.idea/modules.xml
diff --git a/api/.idea/vcs.xml b/api/.idea/vcs.xml
diff --git a/Dockerfile → api/Dockerfile b/Dockerfile → api/Dockerfile
diff --git a/api/README.md b/api/README.md
@@ -0,0 +1,62 @@
+# api
+
+## Building and training the sky brightness model
+
+> Note that `globe_at_night.tar.gz` will need to unpacked into `./data/globe_at_night`
+
+- `python -m ctts.model.build` to write the csv that the model trains on
+- `python -m ctts.model.train` to train on the data in the csv
+
+## HTTP APIs
+
+### how to run locally
+
+> Note: tested on python 3.11
+
+```sh
+pip install -r requirements.txt
+python -m uvicorn ctts.api:app --reload
+```
+
+- artificial sky brightness (light pollution)
+- predictive sky brightness
+
+### endpoints
+
+#### `/api/v1/pollution`
+
+Gets the approximate artificial sky brightness
+map [RGBA pixel value](https://djlorenz.github.io/astronomy/lp2022/colors.html) for a lat and lon (for the year 2022).
+
+```sh
+curl "localhost:8000/api/v1/pollution?lat=40.7277478&lon=-74.0000374"
+```
+
+```json
+{
+  "r": 255,
+  "g": 255,
+  "b": 255,
+  "a": 255
+}
+```
+
+#### `/api/v1/prediction`
+
+Gets the predicted sky brightness at `lat` and `lon` for the current time.
+
+```sh
+curl "http://localhost:8000/api/v1/prediction?lat=-30.2466&lon=-70.7494"
+
+```
+
+```json
+{
+  "sky_brightness": 22.0388
+}
+```
+
+### swagger ui
+
+Open the [ui](http://localhost:8000/docs) in a browser.
+
diff --git a/ctts/__init__.py → api/__init__.py b/ctts/__init__.py → api/__init__.py
diff --git a/ctts/api.py → api/api.py b/ctts/api.py → api/api.py
diff --git a/ctts/data/globe_at_night.csv → api/data/globe_at_night.csv b/ctts/data/globe_at_night.csv → api/data/globe_at_night.csv
diff --git a/ctts/data/globe_at_night.tar.gz → api/data/globe_at_night.tar.gz b/ctts/data/globe_at_night.tar.gz → api/data/globe_at_night.tar.gz
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,4 +10,3 @@ __pycache__/
		data/globe_at_night/*.csv

		prediction/*.csv
		validation/*.csv