Using with Google Colab

SpecpolFlow can be used inside Google Colab, Google’s web-based Jupyter Notebook service.

We recommend using pip to install the most recent stable release of SpecpolFlow; however, the following commands can be used to install SpecpolFLow in Google Colab directly from GitHub.

To install SpecpolFlow directly from the main GitHub repository, use

!pip install "git+https://github.com/folsomcp/specpolFlow"

To install any version of SpecpolFlow released on GitHub, use

!pip install "git+https://github.com/folsomcp/specpolFlow/INSERT_RELEASE_TAG"

The most recent release of SpecpolFlow can be installed in the Colab environment using pip:

!pip install specpolFlow

Then, SpecpolFlow can then be imported into a Python session as usual:

import specpolFlow as pol

To check the version of SpecpolFlow being accessed, type

print(pol.__version__)

To check a docstring from a function, type

help(pol.read_lsd)

The functions that open interactive graphical UIs (normPlot and cleanMaskUI) don’t full work in Colab since Colab dosen’t support opening new windows; all other routines are fully supported, though.