Add bestDetector, update documentation (#28)

* Update for bestdetector

* Update test data

Author: robertdstein

.gitignore

@@ -1,4 +1,5 @@
 .idea
+.DS_Store
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -6,6 +6,10 @@ API interactions for WINTER
 [![PyPI version](https://badge.fury.io/py/winterapi.svg)](https://badge.fury.io/py/winterapi)
 
 ## Installation
+
+We advise you to install the package in a virtual environment or conda environment.
+You will need python 3.10 or later to use this package.
+
 ### Install from pypi
 ```bash
 pip install winterapi
@@ -18,3 +22,25 @@ cd winterapi
 pip install --editable ".[dev]"
 pre-commit install
 ```
+
+## Updating the package
+
+You will need to occasionally update the package to get the latest features and bug fixes. 
+Sometimes the server will require a newer version of the package to interact with it, 
+and you will receive a warning when using winterapi.
+You can update by running the following command:
+
+### Updating for pypi
+```bash
+pip install --upgrade winterapi
+```
+
+or 
+
+### Updating from source
+```bash
+cd winterapi
+git pull
+pip install --editable ".[dev]"
+pre-commit install
+```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "winterapi"
-version = "1.0.0"
+version = "1.1.0"
 description = ""
 authors = [
     {name = "Robert Stein", email = "rdstein@caltech.edu"}
@@ -36,7 +36,7 @@ dependencies = [
     "jupyter",
     "backoff",
     "pydantic",
-    "wintertoo>=1.2.0"
+    "wintertoo>=1.3.1"
 ]
 [project.optional-dependencies]
 dev = [

tests/testdata/test_schedule.csv

@@ -1,7 +1,7 @@
-targName,raDeg,decDeg,fieldID,filter,visitExpTime,priority,progPI,progName,progID,validStart,validStop,observed,maxAirmass,ditherNumber,ditherStepSize,obsHistID
-test_field,211.56398,54.0,3944,Y,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,0
-test_field,211.56398,54.0,3944,J,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,1
-test_field,211.56398,54.0,3944,Hs,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,2
-test_radec,210.910674637,54.3116510708,999999999,Y,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,3
-test_radec,210.910674637,54.3116510708,999999999,J,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,4
-test_radec,210.910674637,54.3116510708,999999999,Hs,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,5
+targName,raDeg,decDeg,fieldID,filter,visitExpTime,priority,progPI,progName,progID,validStart,validStop,observed,maxAirmass,ditherNumber,ditherStepSize,bestDetector,obsHistID
+test_field,211.56398,54.0,3944,Y,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,True,0
+test_field,211.56398,54.0,3944,J,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,True,1
+test_field,211.56398,54.0,3944,Hs,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,9,30.0,True,2
+test_radec,210.910674637,54.3116510708,999999999,Y,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,True,3
+test_radec,210.910674637,54.3116510708,999999999,J,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,True,4
+test_radec,210.910674637,54.3116510708,999999999,Hs,30.0,50.0,Stein,2023A999,0,62721.1894969287,62722.1894969452,False,2.0,1,30.0,True,5