Metadata-Version: 2.1
Name: pgb_utils
Version: 0.1.2
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
Description: # `pgb_utils`: Tools for interacting with Pitt-Google Broker
        
        See:
        - [data_overview.md](data_overview.md) for an intro to our data products and services.
        - [tutorials/PGB_Tutorial.ipynb](tutorials/PGB_Tutorial.ipynb) for an intro on using this package to access our data.
        
        `pgb_utils` is a collection of helper functions to facilitate interaction with Pitt-Google Broker 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
        
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
