Documentation (#10)

* Moved _update_coordinates

* Updated Kepler _update_coordinates

* renamed functions

* wording update

* Added tutorial notebook

* Improved tutorial format

* merge with origin main

* Update change file

* fixed formatting

CHANGES.rst

@@ -3,7 +3,10 @@
 
 - Added the option to use the initial TESS commissioning PRF files [#9]
 - Modified tessprf.py and keplerprf.py to use only the closest PRF measurements to create the supersampled PRF [#8]
+- Renamed 'update_coordinates' to 'check_coordinates' for Kepler and TESS [#10]
+- Added a jupyter notebook demo [#10]
 - Added cache_dir flag to change default location for reading/writing engineer files [#13]
+
 1.0.3 (2024-07-30)
 ==================
 

docs/README.md

@@ -35,7 +35,7 @@ or
 
 ```python
 import lkprf
-prf = lkprf.TESSPRF(camera=1, ccd=1)
+prf = lkprf.TESSPRF(camera=1, ccd=1) # Optionally specify a sector 
 ```
 
 You can then use either the `evaluate` or `gradient` functions to get the estimate of the PRF at a location, as shown below.
@@ -44,7 +44,7 @@ You can then use either the `evaluate` or `gradient` functions to get the estima
 prf.evaluate(targets=[(5, 5)], origin=(0, 0), shape=(11, 11))
 ```
 
-This will return an array with shape  `(1, 11, 11)`, which contains an `(11, 11)` image containing one target at location `(row=5, column=5)`. The image origin is at `(row=0, column=0)`.
+This will return an array with shape  `(1, 11, 11)`, which contains an `(11, 11)` image containing one target at location `(row=5, column=5)`. The image origin is at `(row=0, column=0)`. Note that for Kepler and TESS, an origin of (0,0) contains [collateral](https://heasarc.gsfc.nasa.gov/docs/tess/data-products.html) (non-science) pixels; however, lkprf will still generate the expected model at this location. 
 
 ```python
 prf.evaluate(targets=[(5, 5), (9, 9)], origin=(0, 0), shape=(11, 11))
@@ -82,6 +82,10 @@ Below is an example image for the TES PRF, for Camera 1, CCD 1, with a source at
 
 ![TESS PRF Example](images/TESS.png)
 
+## Where can I learn more?
+
+For more examples of how to use lkprf to generate TPF-like PRF models, see this [tutorial](tutorials/lkprf_TPF_example.ipynb). 
+
 ## Problems with downloading PRF data
 
 To use `lkPRF` you will have to be connected to the internet to download the relevant files. After you download the data for a given Camera/CCD/Channel these files will be stored within the package, so you will be able to use the data offline.