Getting started with gwlandscape-python

Installation

You will require Python 3.7+ to be able to use gwlandscape-python. The recommended way to install gwlandscape-python is with pip:

pip install gwlandscape-python

Getting Access

In order to be able to use the gwlandscape-python package, you will need LIGO credentials or a GWLandscape account. You will also need an API Token associated with that account. You can use your GWLandscape or LIGO account details on the GWLandscape login page.

If you don’t have an existing GWLandscape account, register here.

Using your GWLandscape or LIGO account, you can generate an API token. You should be greeted with a page which has a “Create Token” button. If you click on this, a new, unique API token will be generated, which can be revealed by clicking on the text.

An API token operates as your credentials, replacing your username and password when using the API, hence it is hidden by default. The “Copy Token” button will copy the hidden token, which is a string of 64 characters, to your clipboard. You are also able to revoke your token at any point by clicking the “Revoke Token” button, at which point the token will cease to function. You must not share it with anybody and should revoke and recreate it if somebody else obtains it.