Initial Setup

Learning Objectives:

Complete the initial setup required for data access:

Our broker lives on Google Cloud Platform (GCP). To access the data, you need a free GCP project of your own with a configured service account authenticating your access to Google’s APIs. You can then connect using many different languages; our tutorials demonstrate Python and command-line methods.

This setup only needs to be done once per project/local machine.

The end of this tutorial includes instructions to delete the project.

Step 1: Create a GCP project

Go to the Google Cloud Resource Manager and login with a Google or Gmail account (go here if you need to create one). Click “Create Project” (A). Enter a project name and write down the project ID (B), you will need it below. Click “Create”.

GCP setup

Step 2: Configure authentication

Complete the following on GCP:

Go to Google’s “Getting started with authentication” page and complete the section Creating a service account where you will create a service account with the “owner” role in your project and download a JSON key file for authentication.

Complete the following locally:

Open a shell on your local machine and execute the following code to set two environment variables. They will be used in the background by the APIs to connect to your project and authenticate your calls to various services like Pub/Sub or BigQuery.

# insert your project ID from step 1:
export GOOGLE_CLOUD_PROJECT=my-pgb-project

# insert the path to the key file you just downloaded
export GOOGLE_APPLICATION_CREDENTIALS=/local/path/to/GCP_auth_key.json

Step 3: Enable and install APIs

Complete the following on GCP:

Enable the desired APIs in your project. Below are direct links to the APIs needed for our tutorials. You only need to enable the ones you want to use (e.g., to complete the Pub/Sub Streams tutorial, enable the Pub/Sub API). Follow the link below, make sure your project is selected in the dropdown menu at the top of the webpage, then click “Enable”.

Experienced users may wish to enable other APIs. This can be done from the API Library: search for and click on the API you want, then click “Enable”.

Complete the following locally:

Install the desired Python and/or command-line tools. Our tutorials demonstrate both methods; you can choose the one you are most comfortable with.

Python API Installs

Recommended method:

Install the pgb-utils package in a Python3 environment using the code below. This will install the Google Cloud BigQuery, Pub/Sub, and Cloud Storage APIs, along with our package which contains working examples of using the Google APIs to access data from the Pitt-Google project. It will also install some standard packages like Astropy and Pandas. Our tutorials use this package to demonstrate Python calls.

If you want to install to a new Conda environment, you can use the provided yaml:

# download the file, create, and activate the environment
conda env create --file pgb_env.yaml
conda activate PGB

# persist the environment variables in the new PGB env
mkdir -p ./etc/conda/activate.d
mkdir -p ./etc/conda/deactivate.d
touch ./etc/conda/activate.d/
touch ./etc/conda/deactivate.d/
echo "export GOOGLE_CLOUD_PROJECT=$GOOGLE_CLOUD_PROJECT" >> ./etc/conda/activate.d/
echo 'unset GOOGLE_CLOUD_PROJECT' >> ./etc/conda/deactivate.d/
echo 'unset GOOGLE_APPLICATION_CREDENTIALS' >> ./etc/conda/deactivate.d/

If you don’t want to use Conda, you can install the package directly using pip (a Python 3.7 environment is recommended):

pip install pgb-utils

Alternate method:

Experienced users who just want to use the Google Cloud APIs directly can install the packages individually. Here are commands to install the BigQuery, Pub/Sub, and Cloud Storage APIs:

pip install google-cloud-bigquery
pip install google-cloud-pubsub
pip install google-cloud-storage

See Python Cloud Client Libraries for a complete list of available APIs.

CLI installs

To access data from the command line, install and configure the CLI using the code below. This will install three tools: gcloud, bq, and gsutil. Their use is demonstrated in our tutorials.

# Windows:
# see

# Linux and MacOS:
curl | bash
# follow the directions

# open a new terminal or restart your shell
# either reactivate the Conda env, or reset the environment variables from step 2

# connect the CLI to your Google account:
gcloud init
# follow the directions
# note this may open a browser and ask you to complete the setup there

# set your new project as the default:
gcloud config set project $GOOGLE_CLOUD_PROJECT

Cleanup: Delete a GCP project

If you are done with your GCP project you can permanently delete it. Go to the Cloud Resource Manager, select your project, and click “DELETE”.