Metadata-Version: 2.1
Name: pgb-utils
Version: 0.1.4
Summary: Tools to interact with Pitt-Google Broker data products and services.
Home-page: https://github.com/mwvgroup/Pitt-Google-Broker
Author: Troy Raen
Author-email: troy.raen@pitt.edu
License: UNKNOWN
Keywords: astronomy,alert broker
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: apache-beam
Requires-Dist: aplpy
Requires-Dist: astropy (==3.2.1)
Requires-Dist: astropy-healpix (==0.6)
Requires-Dist: beautifulsoup4 (==4.8)
Requires-Dist: google-apitools
Requires-Dist: google-cloud-bigquery
Requires-Dist: google-cloud-storage
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: tabulate
Requires-Dist: typing

# Query, download, and process the data

[Pitt-Google-Tutorial-Code-Samples.ipynb](tutorials/Pitt-Google-Tutorial-Code-Samples.ipynb)

All data is public and is hosted in the [Google Cloud](https://cloud.google.com/).
It can be accessed using Google's [Cloud SDK](https://cloud.google.com/sdk) in many languages, including Python and from the command-line.
In addition, Pitt-Google Broker offers the Python package `pgb_utils` which contains wrappers of Cloud SDK methods for some common use cases, and other helper functions.
We view this package as a collection of examples demonstrating the use of the underlying methods.
The Cloud SDK is well developed and documented, and we intend for `pgb_utils` to be an entry point to learning the methods.
You are encouraged to view its source code and adapt/extend it for your specific use cases.
Please open an Issue on GitHub or contact troy.raen@pitt.edu if you run into problems.


## `pgb_utils`

`pgb_utils` is a collection of wrappers and helper functions to facilitate interaction with data. We view it as a set of examples for using the Cloud SDK to access and process the data. The tutorial will demonstrate its use. The package is essentially a set of:

1. Convience wrappers for the [Google Cloud Python SDK](https://cloud.google.com/python/docs/reference)
2. Helper functions for ZTF data decoding and plotting, provided by ZTF (see [Filtering_alerts.ipynb](https://github.com/ZwickyTransientFacility/ztf-avro-alert/blob/master/notebooks/Filtering_alerts.ipynb))
3. Helper functions for running [Apache Beam](https://beam.apache.org/) pipelines

You are encouraged to look at and alter the source code to learn how to use the underlying methods yourself.

Modules and their functionality include:

- `pgb_utils.beam`
    - helper functions for running Apache Beam data pipelines

- `pgb_utils.bigquery`
    - view dataset, table, and schema information
    - query: lightcurves
    - query: cone search
    - cast query results to a `pandas.DataFrame` or `json` formatted string.

- `pgb_utils.figures`
    - plot lightcurves
    - plot cutouts

- `pgb_utils.utils`
    - general utilities such as data type casting


