AstroToolkit 1.3.5__tar.gz → 1.4.0__tar.gz

{AstroToolkit-1.3.5/src/AstroToolkit.egg-info → AstroToolkit-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: AstroToolkit
-Version: 1.3.5
+Version: 1.4.0
 Summary: A package for the gathering and plotting of astronomical data.
 Author-email: Ethan Moorfield <ethan.moorfield@hotmail.co.uk>
 Project-URL: Homepage, https://github.com/WD-planets/AstroToolkit
@@ -29,7 +29,7 @@ Requires-Dist: selenium==4.17.2
 
 # AstroToolkit
 
-AstroToolkit (ATK) is a set of useful tools for fetching, plotting, and analysing astronomical data.
+AstroToolkit (ATK) is a set of tools for fetching, plotting, and analysing astronomical data.
 
 ## Table of Contents
 
@@ -37,49 +37,15 @@ AstroToolkit (ATK) is a set of useful tools for fetching, plotting, and analysin
 2. [Introduction](#introduction)
 3. [Configuration](#configuration)
 4. [Tools](#tools)
+5. [Examples](#examples)
 
 ### ATK Tools
 
-- 1 [Raw Data Tools](#1-raw-data-tools)
-	- 1.1 [dataquery](#11-dataquery)
-	- 1.2 [photquery](#12-photquery)
-	- 1.3 [bulkphotquery](#13-bulkphotquery)
-	- 1.4 [getreddening](#14-getreddening)
-- 2 [Imaging Tools](#2-imaging-tools)
-	- 2.1 [imagequery](#21-imagequery)
-	- 2.2 [plotimage](#22-plotimage)
-- 3 [HRD Tools](#3-hrd-tools)
-	- 3.1 [plothrd](#31-plothrd)
-- 4 [Lightcurve Tools](#4-lightcurve-tools)
-	- 4.1 [lightcurvequery](#41-lightcurvequery)
-	- 4.2 [plotlightcurve](#42-plotlightcurve)
-- 5 [SED Tools](#5-sed-tools)
-	- 5.1 [sedquery](#51-sedquery)
-	- 5.2 [plotsed](#52-plotsed)
-- 6 [Spectrum Tools](#6-spectrum-tools)
-	- 6.1 [spectrumquery](#61-spectrumquery)
-	- 6.2 [plotspectrum](#62-plotspectrum)
-- 7 [Timeseries Tools](#7-timeseries-tools)
-	- 7.1 [plotpowspec](#71-plotpowspec)
-	- 7.2 [tsanalysis](#72-tsanalysis)
-- 8 [Datapage Tools](#8-datapage-tools)
-	- 8.1 [gridsetup](#81-gridsetup)
-	- 8.2 [getbuttons](#82-getbuttons)
-	- 8.3 [getmdtable](#83-getmdtable)
-- 9 [File Handling Tools](#9-file-handling-tools)
-	- 9.1 [savedata](#91-savedata)
-	- 9.2 [readdata](#92-readdata)
-	- 9.3 [export](#93-export)
-- 10 [Miscellaneous Tools](#10-miscellaneous-tools)
-	- 10.1 [showplot](#101-showplot)
-	- 10.2 [saveplot](#102-saveplot)
-	- 10.3 [correctpm](#103-correctpm)
-	- 10.4 [getdistance](#104-getdistance)
-	- 10.5 [convfromdeg](#105-convfromdeg)
-	- 10.6 [convtodeg](#106-convtodeg)
-	- 10.7 [getcolumn](#107-getcolumn)
-	- 10.8 [getsources](#108-getsources)
-	- 10.9 [getpositions](#109-getpositions)
+- 1 [Query](#1-query)
+- 2 [Plot](#2-plot)
+- 3 [Datapage Tools](#3-datapage-tools)
+- 4 [File Handling Tools](#4-file-handling-tools)
+- 5 [Other Tools](#5-other-tools)
 
 <br>
 
@@ -142,25 +108,25 @@ where options is a dictionary containing key : value pairs to set in the config.
 - enable_notifications = False
 	- If True, notifications denoting basic information as each ATK tool is executed will be shown in the terminal. Can be useful for tracking the flow of data.
 - dataquery_radius = 3
-	- This sets the default radius (in arcseconds) to use in the [dataquery](#11-dataquery) tool.
+	- This sets the default radius (in arcseconds) to use in [data queries](#11-data-query).
 - photquery_radius = 3
-	- This sets the default radius (in arcseconds) to use in the [photquery](#12-photquery) tool.
+	- This sets the default radius (in arcseconds) to use in [photometry queries](#12-photometry-query).
 - bulkphotquery_radius = 3
-	- This sets the default radius (in arcseconds) to use in the [bulkphotquery](#13-bulkphotquery) tool.
+	- This sets the default radius (in arcseconds) to use in [bulk photometry queries](#13-bulk-photometry-query).
 - imagequery_size = 30
-	- This sets the default radius (in arcseconds) to use in the [imagequery](#21-imagequery) tool.
+	- This sets the default radius (in arcseconds) to use in [image queries](#15-imaging-query).
 - imagequery_overlays = gaia
-	- This sets the default radius (in arcseconds) to use in the [imagequery](#21-imagequery) tool.
+	- This sets the default radius (in arcseconds) to use in [image queries](#15-imaging-query).
 - lightcurvequery_radius = 3
-	- This sets the default radius (in arcseconds) to use in the [lightcurvequery](#31-lightcurvequery) tool.
+	- This sets the default radius (in arcseconds) to use in [lightcurve queries](#16-lightcurve-query).
 - atlas_username = None
-	- This sets the default username to use for ATLAS lightcurve queries in the [lightcurvequery](#31-lightcurvequery) tool.
+	- This sets the default username to use in ATLAS [lightcurve queries](#16-lightcurve-query).
 - atlas_password = None
-	- This sets the default password to use for ATLAS lightcurve queries in the [lightcurvequery](#31-lightcurvequery) tool.
+	- This sets the default password to use in ATLAS [lightcurve queries](#16-lightcurve-query).
 - sed_radius = 3
-	- This sets the default radius to use in the [sedquery](#41-sedquery) tool.
+	- This sets the default radius to use in [SED queries](#17-sed-query).
 - spectrum_radius = 3
-	- This sets the default radius to use in the [spectrumquery](#51-spectrumquery) tool.
+	- This sets the default radius to use in [spectrum queries](#18-spectrum-query).
 - grid_size = 250
 	- This sets the default grid size to use in the [gridsetup](#71-gridsetup) tool.
 - button_simbad_radius = 3
@@ -202,7 +168,7 @@ parameter = string, name of config parameter from above list
 
 <br><br>
 
-## Tools
+## Tools<a id="tools"></a>
 
 In this section, the available tools will be outlined. Note that if a parameter is listed as having a default parameter CONFIG, this means that this parameter is taken from the config as listed above. These parameters can still be passed to the tool, in which case the config value will be ignored.
 
@@ -216,25 +182,21 @@ In this section, the available tools will be outlined. Note that if a parameter
 
 <br>
 
-### 1. Raw Data Tools<a id="1-raw-data-tools"></a>
-### 1.1. dataquery<a id="11-dataquery"></a>
+## 1. query<a id="1-query"></a>
 
-Returns all available data for a given survey (e.g. magnitudes, positions, etc.).
-
-<br>
-
-**Supported surveys:** gaia, galex, rosat, panstarrs, skymapper, sdss, twomass, wise, erosita
-
-<br>
+Returns available data of a given type from a given survey.
 
 **Usage:**
 
 ```
-dataquery(survey,pos=None,source=None,radius=CONFIG)
+query(type,survey=None,pos=None,source=None,radius=CONFIG)
 ```
 
 where:
 
+```
+type = str, type of data to return
+```
 ```
 survey = str, name of a supported survey
 ```
@@ -245,68 +207,56 @@ pos = list, [ra,dec]
 source = int/str, Gaia source_id
 ```
 ```
-radius = int/float, radius of query
+radius = int/float, radius of query of given type. If not given, will be taken from config value for given query type.
 ```
 
-**Returns:** dict
+<br>
 
-```
-{
-'survey' : str, survey of data
-'type' : 'data'
-'source' : int/str, source used to get data (None if a pos was used)
-'pos' : [ra,dec], pos used to get data (None if a source was used)
-'data' : dict, the returned data
-}
-```
+**Note:** If no data is returned, the 'data' key of the returned dictionary will be set to None.
 
 <br>
 
-**Example:**
+**Supported query types:** data, phot, bulkphot, image, lightcurve, sed, spectra, reddening
 
-To retrieve the parallax of a system through Gaia, and its WISE data:
+<br>
 
-```
-from AstroToolkit.Tools import dataquery
+Below is an outline of the usage and output of each query type. Note that additonal arguments not listed above may be used, see individual query types below for details.
 
-source = 6050296829033196032
+<br>
 
-parallax = dataquery(survey='gaia',source=source)['data']['parallax']
-wise_data = dataquery(survey='wise',source=source)['data']
-```
+**Shortcuts**:
 
-<br><br>
+[Data Queries](#11-data-query)
 
-### 1.2. photquery<a id="12-photquery"></a>
+[Photometry Queries](#12-photometry-query)
 
-Returns data from a given survey, with columns filtered to only include photometry and other basic information.
+[Bulk Photomety Queries](#13-bulk-photometry-query)
 
-<br>
+[Reddening Queries](#14-reddening-query)
+
+[Imaging Queries](#15-imaging-query)
+
+[Lightcurve Queries](#16-lightcurve-query)
+
+[SED Queries](#17-sed-query)
+
+[Spectrum Queries](#18-spectrum-query)
 
-**Supported surveys:** gaia,panstarrs,skymapper,galex,rosat,sdss,wise,twomass
+[HRD Queries](#19-hrd-query)
 
 <br>
 
-**Usage:**
+### 1.1 Data Query<a id="11-data-query"></a>
 
-```
-photquery(survey,pos=None,source=None,radius=CONFIG)
-```
+Type argument: 'data'
 
-where:
+Description: Returns all available raw data for a given survey
 
-```
-survey = str, name of a supported survey
-```
-```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
-```
-```
-radius = int/float, radius of query
-```
+Supported Arguments: survey, pos, source, radius (all defined [above](#1-query))
+
+Supported Surveys: gaia, galex, rosat, panstarrs, skymapper, sdss, twomass, wise, erosita
+
+<br>
 
 **Returns:** dict
 
@@ -320,42 +270,43 @@ radius = int/float, radius of query
 }
 ```
 
-<br>
-
-**Example:**
+<br><br>
 
-To retrieve the 2MASS photometry for an object:
-```
-from AstroToolkit.Tools import photquery
+### 1.2 Photometry Query<a id="12-photometry-query"></a>
 
-data=photquery(survey='twomass',source=6050296829033196032)['data']
-```
+Type argument: 'phot'
 
-<br>
+Description: Returns all photometry available from a given survey, as well as some basic parameters such as coordinates.
 
-### 1.3. bulkphotquery<a id="13-bulkphotquery"></a>
+Supported Arguments: survey, pos, source, radius (all defined [above](#1-query))
 
-Returns available photometry from all surveys supported by [photquery](#12-photquery).
+Supported Surveys: gaia, panstarrs, skymapper, galex, rosat, sdss, wise, twomass
 
 <br>
 
-**Usage:**
+**Returns:** dict
 
 ```
-bulkphotquery(pos=None,source=None,radius=CONFIG)
+{
+'survey' : str, survey of data
+'type' : 'data'
+'source' : int/str, source used to get data (None if a pos was used)
+'pos' : [ra,dec], pos used to get data (None if a source was used)
+'data' : dict, the returned data
+}
 ```
 
-where:
+<br><br>
 
-```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
-```
-```
-radius = int/float, radius of query
-```
+### 1.3 Bulk Photometry Query<a id="13-bulk-photometry-query"></a>
+
+Type argument: 'bulkphot'
+
+Description: Returns all photometry available from all surveys supported by [photometry queries](#12-photometry-query)
+
+Supported Arguments: pos, source, radius (all defined [above](#1-query))
+
+<br>
 
 **Returns:** dict
 
@@ -375,42 +326,17 @@ radius = int/float, radius of query
 
 **Note:** The value of each survey will be set to None if no data was returned. E.g. if no galex data was returned, the value of the ['galex'] key would be None.
 
-<br>
-
-**Example:**
-
-To retrieve the gaia and galex data for an object:
-
-```
-from AstroToolkit.Tools import bulkphotquery
-
-bulk_phot=bulkphotquery(source=6050296829033196032)['data']
-
-gaia_data=bulk_phot['gaia']
-galex_data=bulk_phot['galex']
-```
-
-<br>
-
-### 1.4. getreddening<a id="14-getreddening"></a>
-
-Returns the reddening of a Gaia source.
+<br><br>
 
-Currently supported reddening surveys:
-- STILISM (https://stilism.obspm.fr/)
+### 1.4. Reddening Query<a id="14-reddening-query"></a>
 
-<br>
+Type argument: 'reddening'
 
-**Usage:**
+Description: Returns the reddening for a given Gaia source from a given survey
 
-```
-getreddening(source)
-```
+Supported Arguments: source (defined [above](#1-query))
 
-where:
-```
-source = int/str, Gaia source_id
-```
+Supported Surveys: stilism (https://stilism.obspm.fr/)
 
 <br>
 
@@ -433,17 +359,11 @@ source = int/str, Gaia source_id
 
 <br><br>
 
-### 2. Imaging Tools<a id="2-imaging-tools"></a>
-
-These functions retrieve and plotimages from supported surveys.
-
-**Note:** When using a 'pos' as input, some detections can be missing for high proper motion objects. When instead using a source as input, this is no longer a problem as the detection search radius is increased to account for this proper motion.
+### 1.5 Imaging Query<a id="15-imaging-query"></a>
 
-<br>
-
-### 2.1. imagequery<a id="21-imagequery"></a>
+Type argument: 'image'
 
-Retrieves an image from a given survey. Overlays  can be used to overlay detections from different surveys. There are two types of overlay: detections and tracers. Detections are proper motion-corrected circles that scale with the magnitude of the detection, and show that there is data available for a given object in a given survey. 
+Description: Returns an image from a given survey. Overlays  can be used to overlay detections from different surveys. There are two types of overlay: detections and tracers. Detections are proper motion-corrected circles that scale with the magnitude of the detection, and show that there is data available for a given object in a given survey. 
 
 Tracers (which are detections created from lightcurve surveys) can be used both to show that lightcurve data is available, but also to trace an object through time.
 
@@ -455,40 +375,10 @@ Tracers (which are detections created from lightcurve surveys) can be used both
 
 ![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/tracer_example.png?raw=true)
 
-<br>
-
-Supported surveys:
-- panstarrs, supported bands = g, r, i, z, y
-- skymapper, supported bands = g, r, i, z, u, v
-- dss, supported bands = g
-
-**Note:** Can also use 'any' to perform an image query according to the hierarchy: panstarrs > skymapper > dss
-
-<br>
-
-Supported overlays: gaia, galex_nuv, galex_fuv, rosat,sdss, twomass, wise, ztf, erosita ,atlas, gaia_lc, asassn, crts
-
-**Note:** Can also use 'all', which will enable overlays for all supported surveys.
-
-<br>
-
-**Usage:**
-
-```
-imagequery(survey,pos=None,source=None,size=CONFIG,band='g',overlays=CONFIG)
-```
+Supported Arguments: survey, pos, source, size, band, overlays
 
 where:
 ```
-survey = str, name of a supported survey
-```
-```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
-```
-```
 size = int/float, size of image in arcsec
 ```
 ```
@@ -498,6 +388,19 @@ band = str, string containing the required bands (e.g. for all panstarrs bands,
 overlays = str, required detection overlays (e.g. for gaia and wise detections, use overlays='gaia,wise') 
 ```
 
+and all other arguments have been defined [above](#1-query).
+
+Supported overlays: gaia, galex_nuv, galex_fuv, rosat,sdss, twomass, wise, ztf, erosita ,atlas, gaia_lc, asassn, crts
+
+**Note:** Can also use 'all', which will enable overlays for all supported surveys.
+
+Supported Surveys:
+- panstarrs, supported bands = g, r, i, z, y
+- skymapper, supported bands = g, r, i, z, u, v
+- dss, supported bands = g
+
+<br>
+
 **Returns:** dict
 
 ```
@@ -531,114 +434,29 @@ overlays = str, required detection overlays (e.g. for gaia and wise detections,
 }
 ```
 
-<br>
-
-### 2.2. plotimage<a id="22-plotimage"></a>
-
-Plots images in format returned by [imagequery](#21-imagequery).
-
-<br>
-
-**Usage:**
-
-```
-plotimage(data)
-```
-
-where:
-```
-data = dict in format returned by imagequery
-```
-
-**Returns:** dict
-
-```
-{
-'type' : 'image'
-'survey' : str, survey of image
-'source' : int/str, source used to get image (None if a pos was used)
-'pos' : [ra,dec], pos used to get image (None if a source was used)
-'plot' : bokeh figure object, the actual plot
-'ATKfilename' : the default filename given by ATK
-}
-```
-
-**Note:** if a plot is not returned (e.g. if no data was supplied to the plotting tool), the 'plot' key will be set to None.
-
-<br>
-
-**Example:**
-
-To retrieve and plot an image:
-```
-from AstroToolkit.Tools import imagequery,plotimage,showplot
-
-image=imagequery(survey='any',source=6050296829033196032,overlays='gaia')
-plot=plotimage(image)
-showplot(plot)
-```
-
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/imaging_example.png?raw=true)
-
 <br><br>
 
-### 3. HRD Tools<a id="3-hrd-tools"></a>
-### 3.1. plothrd<a id="31-plothrd"></a>
+### 1.6 Lightcurve Query<a id="16-lightcurve-query"></a>
 
-Returns a HRD with a source or list of sources overlayed over a Gaia 100pc background sample.
+Type argument: 'lightcurve'
 
-<br>
-
-**Usage:**
+Description: Returns lightcurve data from a given survey.
 
-```
-plothrd(source=None,sources=None)
-```
+Supported Arguments: survey, pos, source, radius, username, password, sigmaclip
 
 where:
-
 ```
-source = int/str, Gaia source_id
-```
-```
-sources = list of sources
+username = str, ATLAS username, hence only used in ATLAS queries
 ```
-
-**Returns:** dict
-
 ```
-{
-'type' : 'hrd'
-'source' : int/str, source overlayed in HRD
-'sources' : list, sources overlayed in HRD if multiple were given
-'plot' : bokeh figure object, the actual plot
-'ATKfilename' : the default filename given by ATK
-}
+password = str, ATLAS password, hence only used in ATLAS queries
 ```
-
-<br>
-
-**Example:**
-To retrieve a HRD with a single source overlayed:
 ```
-from AstroToolkit.Tools import plothrd,showplot
-
-plot=plothrd(source=6050296829033196032)
-showplot(plot)
+sigmaclip = int, performs sigma clipping on the data to this number of standard deviations
 ```
+and all other arguments have been defined [above](#1-query).
 
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/hrd_example.png?raw=true)
-
-<br><br>
-
-### 4. Lightcurve Tools<a id="4-lightcurve-tools"></a>
-### 4.1. lightcurvequery<a id="41-lightcurvequery"></a>
-
-Returns lightcurve data for a given survey.
-
-<br>
-
-Supported surveys:
+Supported Surveys (and filter bands):
 - ZTF (ztf) - g, r, i
 - ATLAS (atlas) - o, c, i
 - ASAS-SN (asassn) - g, v
@@ -649,33 +467,6 @@ Supported surveys:
 
 <br>
 
-```
-lightcurvequery(survey,pos=None,source=None,radius=CONFIG,username=CONFIG,password=CONFIG,sigmaclip=None)
-```
-
-where:
-```
-survey = str, name of a supported survey
-```
-```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
-```
-```
-radius = int/float, radius of lightcurve query
-```
-```
-username = str, ATLAS username, hence only used in ATLAS queries
-```
-```
-password = str, ATLAS password, hence only used in ATLAS queries
-```
-```
-sigmaclip = int, performs sigma clipping on the data to this number of standard deviations
-```
-
 **Returns:** list of dicts
 
 list of lightcurve data dictionaries with an entry for each band in that survey (see below). Each entry has the format:
@@ -700,212 +491,231 @@ list of lightcurve data dictionaries with an entry for each band in that survey
 }
 ```
 
-<br>
-
-### 4.2. plotlightcurve<a id="42-plotlightcurve"></a>
+<br><br>
 
-Plots lightcurves in the format returned by [lightcurvequery](#41-lightcurvequery).
+### 1.7 SED Query<a id="17-sed-query"></a>
 
-<br>
+Type argument: 'sed'
 
-**Usage:**
+Description: Queries all supported [photometry surveys](#12-photometry-query) and returns SED data.
 
-```
-plotlightcurve(data,colour='black')
-```
+Supported Arguments: pos, source, radius (all defined [above](#1-query))
 
-where:
-```
-data = dict if passing a single lightcurve, list of dicts if passing multiple lightcurves
-```
-```
-colour = str, name of a supported colour. Only used when passing a single lightcurve
-```
-```
-colours = list of strings denoting supported colours, e.g. ['green','red','blue']. Only used when passing multiple lightcurves
-```
+<br>
 
 **Returns:** dict
 
 ```
 {
-'type' : 'lightcurve'
-'survey' : str, survey of lightcurve
+'type' : 'sed'
 'source' : int/str, source used to get data (None if a pos was used)
 'pos': [ra,dec], pos used to get data (None if a source was used)
-'plot' : bokeh figure object, the actual plot
-'ATKfilename' : the default filename given by ATK
+'data': list of entries with each entry taking the form of a dict:
+	{
+    'survey' : str, survey of data point
+    'wavelength' : filter wavelength of data point
+    'flux' : flux through filter
+    'rel_err' : relative error on flux
+    }
 }
 ```
 
-<br>
-
-**Example**:
-To retrieve and plot lightcurves from ZTF:
-```
-from AstroToolkit.Tools import lightcurvequery,plotlightcurve,showplot
-
-lightcurves=lightcurvequery(survey='ztf',source=6050296829033196032)
-showplot(plotlightcurve(lightcurves,colours=['green','red','blue']))
-```
+<br><br>
 
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/lightcurve_example.png?raw=true)
+### 1.8 Spectrum Query<a id="18-spectrum-query"></a>
 
-**Note:** Each band will then be toggleable using the legend.
+Type argument: 'spectra'
 
-<br><br>
+Description: Returns spectrum data for a given survey.
 
-### 5. SED Tools<a id="5-sed-tools"></a>
-### 5.1. sedquery<a id="51-sedquery"></a>
+Supported Arguments: survey, pos, source, radius (all defined [above](#1-query))
 
-Queries all supported photometry surveys and returns SED data.
+Supported Surveys: sdss
 
 <br>
 
-**Usage:**
+**Returns:**
 
 ```
-sedquery(pos=None,source=None,radius=CONFIG)
+{
+'type' : 'spectra'
+'survey' : str, survey of detection
+'source' : int/str, source used to get data (None if a pos was used)
+'pos': [ra,dec], pos used to get data (None if a source was used)
+'data': {
+        'wavelength' : list of wavelength values
+        'flux' : list of flux values
+        }
+}
 ```
 
+<br><br>
+
+### 1.9 HRD Query<a id="19-hrd-query"></a>
+
+Type argument: 'hrd'
+
+Description: Returns data for Gaia HRD creation given a Gaia source/list of Gaia sources.
+
+Supported Arguments: sources
+
 where:
 ```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
-```
-```
-radius = int/float, radius of data query
+sources = single Gaia source or list of Gaia sources
 ```
 
+<br>
+
 **Returns:** dict
 
 ```
-{
-'type' : 'sed'
-'source' : int/str, source used to get data (None if a pos was used)
-'pos': [ra,dec], pos used to get data (None if a source was used)
-'data': list of entries with each entry taking the form of a dict:
-	{
-    'survey' : str, survey of data point
-    'wavelength' : filter wavelength of data point
-    'flux' : flux through filter
-    'rel_err' : relative error on flux
-    }
-}
+'type' : 'hrd'
+'sources' : list, list of input Gaia sources
+'data': {
+        'absg' : list, absolute g magnitudes of given sources
+        'bp-rp' : list, bp-rp values of given sources
+        }
 ```
 
-<br>
-
-### 5.2. plotsed<a id="52-plotsed"></a>
+<br><br>
 
-Plots SEDs in the format returned by [sedquery](#51-sedquery).
+## 2. plot<a id="2-plot"></a>
 
-<br>
+Interprets and plots data.
 
 **Usage:**
 
 ```
-plotsed(data)
+plot(data,type=None)
 ```
 
 where:
-
 ```
-data = dict in format returned by sedquery
+data = list/dict data in structure returned by the query tool
 ```
 
-**Returns:** dict
+<br>
 
-```
-{
-'type' : 'sed'
-'source' : int/str, source used to get data (None if a pos was used)
-'pos': [ra,dec], pos used to get data (None if a source was used)
-'plot' : bokeh figure object, the actual plot
-'ATKfilename' : the default filename given by ATK
-}
-```
+**Note:** If no plot is returned, the 'plot' key of the returned dictionary will be set to None.
 
 <br>
 
-**Example:** To retrieve and plot an SED:
-```
-from AstroToolkit.Tools import sedquery,plotsed,showplot
+**Supported plot types:** image, lightcurve, sed, spectra, powspec, hrd
 
-data=sedquery(source=6050296829033196032)
-showplot(plotsed(data))
-```
+<br>
 
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/sed_example.png?raw=true)
+Below is an outline of the usage and output of each plot type. Note that additonal arguments not listed above may be used, see individual plot types below for details.
 
-<br><br>
+<br>
+
+**Shortcuts**:
 
-### 6. Spectrum Tools<a id="6-spectrum-tools"></a>
-### 6.1. spectrumquery<a id="61-spectrumquery"></a>
+[Image Plotting](#21-image-plotting)
 
-Returns spectrum data from a given survey.
+[Lightcurve Plotting](#22-lightcurve-plotting)
+
+[SED Plotting](#23-sed-plotting)
+
+[Spectrum Plotting](#24-spectrum-plotting)
+
+[HRD Plotting](#25-hrd-plotting)
+
+[Power Spectra Plotting](#26-power-spectra-plotting)
 
 <br>
 
-**Usage:**
+### 2.1 Image Plotting<a id="21-image-plotting"></a>
+
+Type argument: 'image'
+
+Description: Plots images in format returned by [image queries](#15-imaging-query).
+
+<br>
+
+**Returns:** dict
 
 ```
-spectrumquery(survey=None,pos=None,source=None,radius=CONFIG)
+{
+'type' : 'image'
+'survey' : str, survey of image
+'source' : int/str, source used to get image (None if a pos was used)
+'pos' : [ra,dec], pos used to get image (None if a source was used)
+'plot' : bokeh figure object, the actual plot
+'ATKfilename' : the default filename given by ATK
+}
 ```
 
+<br><br>
+
+### 2.2 Lightcurve Plotting<a id="22-lightcurve-plotting"></a>
+
+Type argument: 'lightcurve'
+
+Description: Plots lightcurves in the format returned by [lightcurve queries](#16-lightcurve-query). Here, you can either pass a single lightcurve, or multiple lightcurves (e.g. those returned from [lightcurve queries](#16-lightcurve-query)).
+
+Additional Supported Arguments: colour, colours
+
 where:
 ```
-survey = str, name of a supported survey
-```
-```
-pos = list, [ra,dec]
-```
-```
-source = int/str, Gaia source_id
+colour = str, name of a supported colour. Only used when passing a single lightcurve
 ```
 ```
-radius = int/float, radius of data query
+colours = list of strings denoting supported colours, e.g. ['green','red','blue']. Only used when passing multiple lightcurves
 ```
 
-**Returns:** dict
+**Note:** CRTS' data server is not designed for scripted queries. As a result, queries are limited in the toolkit to one query per 15 seconds. This cooldown is managed using the CRTS_TIMER.txt file in the Settings directory of the package files, and hence the contents of this file should not be edited.
+
+<br>
 
+**Returns:** dict
 ```
 {
-'type' : 'spectra'
-'survey' : str, survey of detection
+'type' : 'lightcurve'
+'survey' : str, survey of lightcurve
 'source' : int/str, source used to get data (None if a pos was used)
 'pos': [ra,dec], pos used to get data (None if a source was used)
-'data': {
-        'wavelength' : list of wavelength values
-        'flux' : list of flux values
-        }
+'plot' : bokeh figure object, the actual plot
+'ATKfilename' : the default filename given by ATK
 }
 ```
 
-<br>
+<br><br>
 
-### 6.2. plotspectrum<a id="62-plotspectrum"></a>
+### 2.3 SED Plotting<a id="23-sed-plotting"></a>
 
-Plots spectra in the format returned by [spectrumquery](#61-spectrumquery).
+Type argument: 'sed'
 
-<br>
+Description: Plots SED data in the format returned by [SED queries](#17-sed-query).
 
-**Usage:**
+<br>
 
+**Returns:** dict
 ```
-plotspectrum(data)
+{
+'type' : 'sed'
+'source' : int/str, source used to get data (None if a pos was used)
+'pos': [ra,dec], pos used to get data (None if a source was used)
+'data': list of entries with each entry taking the form of a dict:
+	{
+    'survey' : str, survey of data point
+    'wavelength' : filter wavelength of data point
+    'flux' : flux through filter
+    'rel_err' : relative error on flux
+    }
+}
 ```
 
-where:
+<br><br>
 
-```
-data = dict in format returned by spectrumquery
-```
+### 2.4 Spectrum Plotting<a id="24-spectrum-plotting"></a>
 
-**Returns:** dict
+Type argument: 'spectra'
 
+Description: Plots spectrum data in the format returned by [spectrum queries](#18-spectrum-query).
+
+<br>
+
+**Returns:** dict
 ```
 {
 'type' : 'spectrum'
@@ -917,39 +727,36 @@ data = dict in format returned by spectrumquery
 }
 ```
 
-<br>
+<br><br>
 
-**Example:**
-To retrieve and plot an SDSS spectrum:
-```
-from AstroToolkit.Tools import spectrumquery,plotspectrum,showplot
+### 2.5 HRD Plotting<a id="25-hrd-plotting"></a>
 
-data=spectrumquery(survey='sdss',source=587316166180416640)
-plot=plotspectrum(data)
-showplot(plot)
-```
+Type argument: 'hrd'
 
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/spectrum_example.png?raw=true)
+Description: Plots Gaia HRD data in the format returned by [hrd queries](#19-hrd-query).
 
-<br><br>
+<br>
 
-### 7. Timeseries Tools<a id="7-timeseries-tools"></a>
-### 7.1 plotpowspec<a id="71-plotpowspec"></a>
+**Returns:** dict
+```
+{
+'type' : 'hrd'
+'source' : int/str, source overlayed in HRD
+'sources' : list, sources overlayed in HRD if multiple were given
+'plot' : bokeh figure object, the actual plot
+'ATKfilename' : the default filename given by ATK
+}
+```
 
-Plots a power spectrum from lightcurve data in the format returned by [lightcurvequery](#41-lightcurvequery)
+<br><br>
 
-<br>
+### 2.6 Power Spectra Plotting<a id="26-power-spectra-plotting"></a>
 
-**Usage:**
+Type argument: 'powspec'
 
-```
-plotpowspec(data)
-```
+Description: Plots power spectra from lightcurve data in the format returned by [lightcurve queries](#16-lightcurve-query).
 
-where:
-```
-data = dict or list in format returned by lightcurvequery
-```
+<br>
 
 **Returns:** dict
 
@@ -964,25 +771,11 @@ data = dict or list in format returned by lightcurvequery
 }
 ```
 
-<br>
-
-**Example:**
-To retrieve lightcurve data from ZTF and plot a power spectrum:
-```
-from AstroToolkit.Tools import lightcurvequery,plotpowspec,showplot
-
-data=lightcurvequery(survey='ztf',source=6050296829033196032)
-plot=plotpowspec(data)
-showplot(plot)
-```
-
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/powspec_example.png?raw=true)
-
 <br><br>
 
-### 7.2 tsanalysis<a id="72-tsanalysis"></a>
+### 2.7 Timeseries Analysis<a id="27-timeseries-analysis"></a>
 
-Runs period analysis on lightcurve data in format returned by [lightcurvequery](#lightcurvequery)
+Description: Not explicitly a plotting function, but included here for completeness. Runs period analysis on lightcurve data in format returned by [lightcurve queries](#16-lightcurve-query).
 
 <br>
 
@@ -995,25 +788,12 @@ tsanalysis(data)
 where:
 
 ```
-data = dict or list in format returned by lightcurvequery
-```
-
-<br>
-
-**Example:**
-To retrieve lightcurve data from ZTF and perform timeseries analysis:
-```
-from AstroToolkit.Tools import lightcurvequery,tsanalysis
-
-data=lightcurvequery(survey='ztf',source=6050296829033196032)
-plot=tsanalysis(data)
+data = dict or list in format returned by lightcurve queries
 ```
 
-![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/tsanalysis_example.png?raw=true)
-
 <br><br>
 
-## 8. Datapage Tools<a id="8-datapage-tools"></a>
+## 3. Datapage Tools<a id="3-datapage-tools"></a>
 
 These functions are used to create custom datapages from any plots/data supported by AstroToolkit.
 
@@ -1025,7 +805,17 @@ Below is the datapage produced by this example. Once the script to create these
 
 <br>
 
-### 8.1. gridsetup<a id="81-gridsetup"></a>
+Shortcuts:
+
+[Grid Creation](#31-gridsetup)
+
+[SIMBAD/Vizier Buttons](#32-getbuttons)
+
+[Metadata Table Creation](#33-getmdtable)
+
+<br><br>
+
+### 3.1 gridsetup<a id="31-gridsetup"></a>
 
 Formats plots for datapage creation by sizing them to a grid of given dimensions.
 
@@ -1071,7 +861,7 @@ where the keys "name ..." are the names given to the plots above, and the values
 
 <br>
 
-### 8.2. getbuttons<a id="82-getbuttons"></a>
+### 3.2 getbuttons<a id="32-getbuttons"></a>
 
 Returns a Bokeh figure containing SIMBAD and Vizier buttons for use in datapages.
 
@@ -1115,7 +905,7 @@ vizier_radius = int, radius to use in Vizier queries
 
 <br>
 
-### 8.3. getmdtable<a id="83-getmdtable"></a>
+### 3.3 getmdtable<a id="33-getmdtable"></a>
 
 Creates a table of metadata table using data from supported surveys and/or custom data.
 
@@ -1189,12 +979,23 @@ In this case, an additional 'values' key must be included, and the values/errors
 
 <br><br>
 
-## 9. File Handling Tools<a id="9-file-handling-tools"></a>
+## 4. File Handling Tools<a id="4-file-handling-tools"></a>
+
 These tools can be used to transform many returned ATK data structures into local files, and vice versa. This process is designed to be completely lossless, allowing for the exact data structure that was used to create a file to be recreated at a later date.
 
 <br>
 
-### 9.1. savedata<a id="91-savedata"></a>
+Shortcuts:
+
+[Data Saving](#41-savedata)
+
+[Data Reading](#42-readdata)
+
+[Export Plots to PNG](#43-export)
+
+<br><br>
+
+### 4.1 savedata<a id="41-savedata"></a>
 
 This tool allows for the saving of many ATK data structures into local files.
 
@@ -1224,7 +1025,7 @@ Name of file that the data was saved to
 
 <br>
 
-### 9.2. readdata<a id="92-readdata"></a>
+### 4.2 readdata<a id="42-readdata"></a>
 
 This tool allows for the lossless recreation of ATK data stuctures from files created using [savedata](#91-savedata).
 
@@ -1267,7 +1068,7 @@ showplot(plotlightcurve(recreated_lightcurve_data,colours=['red','orange','yello
 
 <br>
 
-### 9.3. export<a id="93-export"></a>
+### 4.3 export<a id="43-export"></a>
 
 This allows for ATK figures to be saved as a .png file.
 
@@ -1289,15 +1090,35 @@ keephtml = bool. To get the filename for the png, the plot must first be saved a
 
 <br><br>
 
-### 10. Miscellaneous Tools<a id="10-miscellaneous-tools"></a>
+## 5. Other Tools<a id="5-other-tools"></a>
 
-These are tools that do not fit into the above categories, but can still be useful for quickly performing some basic functions.
+Below is a list of the other tools available in ATK.
 
-<br>
+Shortcuts:
+
+[Show Plots](531-showplot)
+
+[Save Plots](532-saveplot)
+
+[Proper Motion Correction](533-correctpm)
+
+[Parallax to Distance](534-getdistance)
+
+[Convert Degrees to HMS/DMS](535-convfromdeg)
+
+[Convert from HMS/DMS to Degrees](536-convtodeg)
 
-### 10.1. showplot<a id="101-showplot"></a>
+[Read fits file columns](#57-getcolumn)
 
-This allows for the plot dictionaries returned by ATK to be opened in the browser. Doing so will also save the plot locally as a .html file. Can also be used with the same functionality as show() from bokeh for non-ATK bokeh figures.
+[Read Sources from a fits file](#58-getsources)
+
+[Read Positions from a fits file](#59-getpositions)
+
+[Open object in SIMBAD/Vizier](#510-webquery)
+
+### 5.1 showplot<a id="51-showplot"></a>
+
+Description: This allows for the plot dictionaries returned by ATK to be opened in the browser. Doing so will also save the plot locally as a .html file. Can also be used with the same functionality as show() from bokeh for non-ATK bokeh figures.
 
 <br>
 
@@ -1308,14 +1129,14 @@ showplot(plot)
 
 where:
 ```
-plot = ATK plot dictionary
+plot = ATK plot dictionary or bokeh figure
 ```
 
-<br>
+<br><br>
 
-### 10.2. saveplot<a id="102-saveplot"></a>
+### 5.2 saveplot<a id="52-saveplot"></a>
 
-This allows for the plot dictionaries returned by ATK to be saved to local .html files without opening them in the browser. Can also be used with the same functionality as save() from bokeh for non-ATK bokeh figures.
+Description: This allows for the plot dictionaries returned by ATK to be saved to local .html files without opening them in the browser. Can also be used with the same functionality as save() from bokeh for non-ATK bokeh figures.
 
 <br>
 
@@ -1326,14 +1147,14 @@ saveplot(plot)
 
 where:
 ```
-plot = ATK plot dictionary
+plot = ATK plot dictionary or bokeh figure
 ```
 
-<br>
+<br><br>
 
-### 10.3. correctpm<a id="103-correctpm"></a>
+### 5.3 correctpm<a id="53-correctpm"></a>
 
-Corrects for proper motion of an object between an input time and a target time.
+Description: Corrects for proper motion of an object between an input time and a target time.
 
 <br>
 
@@ -1370,22 +1191,9 @@ pmdec = float, proper motion in dec direction of object in mas/yr
 
 [ra,dec] of object in degrees, corrected for proper motion.
 
-<br>
-
-**Example:**
-To correct an object for proper motion to the year 2000:
-```
-from AstroToolkit.Tools import dataquery,correctpm
-
-gaia_data=dataquery(survey='gaia',source=6050296829033196032)['data']
-ra,dec,pmra,pmdec=gaia_data['ra'][0],gaia_data['dec'][0],gaia_data['pmra'][0],gaia_data['pmdec'][0]
-
-ra_corrected,dec_corrected=correctpm([2016,0],[2000,0],ra,dec,pmra,pmdec)
-```
-
-<br>
+<br><br>
 
-### 10.4. getdistance<a id="104-getdistance"></a>
+### 5.4 getdistance<a id="54-getdistance"></a>
 
 Simply calculates the distance (1/parallax) of an object given its parallax in mas (the unit of parallax in Gaia).
 
@@ -1410,7 +1218,7 @@ distance of object in pc
 
 <br>
 
-### 10.5. convfromdeg<a id="105-convfromdeg"></a>
+### 5.5 convfromdeg<a id="55-convfromdeg"></a>
 
 Converts deg coordinates to HMS/DMS format
 
@@ -1435,7 +1243,7 @@ pos = list, [ra,dec] of object in degrees
 
 <br>
 
-### 10.6. convtodeg<a id="106-convtodeg"></a>
+### 5.6 convtodeg<a id="56-convtodeg"></a>
 
 Converts HMS/DMS coordinates to deg.
 
@@ -1460,7 +1268,7 @@ pos = list, [ra,dec] of object in [HMS/DMS] format, i.e. [[H,M,S],[D,M,S]]
 
 <br>
 
-### 10.7. getcolumn<a id="107-getcolumn"></a>
+### 5.7 getcolumn<a id="57-getcolumn"></a>
 
 Returns a list of values from a .fits file given a column name.
 
@@ -1484,7 +1292,7 @@ list of values for that column
 
 <br>
 
-### 10.8. getsources<a id="108-getsources"></a>
+### 5.8 getsources<a id="58-getsources"></a>
 
 Returns a list of source values from a .fits file given a column name, which can either be set in the tool or in the config.
 
@@ -1508,7 +1316,7 @@ list of Gaia sources
 
 <br>
 
-### 10.9. getpositions<a id="109-getpositions"></a>
+### 5.9 getpositions<a id="59-getpositions"></a>
 
 Returns a list of ra,dec values from a .fits file given ra and dec column names, which can either be set in the tool or in the config.
 
@@ -1529,3 +1337,173 @@ col_name = str, comma separated string containing names of ra and dec columns. e
 **Returns:** list
 
 list of positions [[ra1,dec1],[ra2,dec2]], etc.
+
+### 5.10 webquery<a id="510-webquery"></a>
+
+Performs SIMBAD/Vizier queries given a source/pos in the web browser.
+
+**Usage:**
+
+```
+webquery(type,source=None,pos=None,radius=CONFIG)
+```
+
+where:
+```
+type = str, type of query from 'simbad' or 'vizier'
+```
+```
+pos = list, [ra,dec]
+```
+```
+source = int/str, Gaia source_id
+```
+```
+radius = int/float, radius of data query. If not given, this is taken from simbad_radius or vizier_radius in the config, depending on the query type
+```
+
+**Returns:** None
+
+<br><br>
+
+## Examples<a id="examples"></a>
+
+### Example 1: Fetching and plotting an image
+
+```
+from AstroToolkit.Tools import query,plot,showplot
+
+image=query(type='image',survey='any',source=6050296829033196032,overlays='gaia')
+figure=plot(image)
+showplot(figure)
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/imaging_example.png?raw=true)
+
+<br><br>
+
+### Example 2: Fetching and plotting a Gaia HRD
+
+```
+from AstroToolkit.Tools import query,plot,showplot
+
+data=query(type='hrd',sources=[6050296829033196032])
+figure=plot(data)
+showplot(figure)
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/hrd_example.png?raw=true)
+
+<br><br>
+
+### Example 3: Fetching and plotting a ZTF lightcurve
+
+```
+from AstroToolkit.Tools import query,plot,showplot
+
+data=lightcurvequery(type='lightcurve',survey='ztf',source=6050296829033196032)
+showplot(plot(data,colours=['green','red','blue']))
+```
+
+**Note:** Each band will then be toggleable using the legend.
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/lightcurve_example.png?raw=true)
+
+<br><br>
+
+### Example 4: Fetching and plotting an SED
+
+```
+from AstroToolkit.Tools import query,plot,showplot
+
+data=query(type='sed',source=6050296829033196032)
+showplot(plot(data))
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/sed_example.png?raw=true)
+
+<br><br>
+
+### Example 5: Fetching and plotting an SDSS spectrum
+
+```
+from AstroToolkit.Tools import query,plot,showplot
+
+data=query(type='spectra',survey='sdss',source=587316166180416640)
+plot=plot(data)
+showplot(plot)
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/spectrum_example.png?raw=true)
+
+<br><br>
+
+### Example 6: Fetching ZTF ligthcurve data, and then plotting it as a power spectrum
+
+```
+from AstroToolkit.Tools import lightcurvequery,plotpowspec,showplot
+
+data=lightcurvequery(survey='ztf',source=6050296829033196032)
+plot=plotpowspec(data)
+showplot(plot)
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/powspec_example.png?raw=true)
+
+<br><br>
+
+### Example 7: Fetching Gaia parallax and WISE data
+
+```
+from AstroToolkit.Tools import query
+
+source = 6050296829033196032
+
+parallax = query(type='data',survey='gaia',source=source)['data']['parallax']
+wise_data = query(type='data',survey='wise',source=source)['data']
+```
+
+### Example 8: Fetching 2MASS photometry for an object
+
+```
+from AstroToolkit.Tools import query
+
+data=query(type='phot',survey='twomass',source=6050296829033196032)['data']
+```
+
+### Example 9: Fetching photometry from all available surveys using a bulk photometry query
+
+```
+from AstroToolkit.Tools import query
+
+bulk_phot=query(type='bulkphot',source=6050296829033196032)['data']
+
+gaia_data=bulk_phot['gaia']
+galex_data=bulk_phot['galex']
+```
+
+<br><br>
+
+### Example 10: Fetching ZTF lightcurve data, and performing timeseries analysis
+
+```
+from AstroToolkit.Tools import query,tsanalysis
+
+data=query(type='lightcurve',survey='ztf',source=6050296829033196032)
+plot=tsanalysis(data)
+```
+
+![](https://github.com/WD-planets/AstroToolkit/raw/latest/README_Images/tsanalysis_example.png?raw=true)
+
+<br><br>
+
+### Example 11: Proper motion correction
+
+```
+from AstroToolkit.Tools import query,correctpm
+
+gaia_data=query(type='data',survey='gaia',source=6050296829033196032)['data']
+ra,dec,pmra,pmdec=gaia_data['ra'][0],gaia_data['dec'][0],gaia_data['pmra'][0],gaia_data['pmdec'][0]
+
+ra_corrected,dec_corrected=correctpm([2016,0],[2000,0],ra,dec,pmra,pmdec)
+```