Installation

Install from PyPI

GRFlood is available on PyPI. To install GRFlood, run this command in your terminal:

pip install GRFlood

Install from conda-forge

GRFlood is also available on conda-forge. If you have Anaconda or Miniconda installed on your computer, you can create a conda Python environment to install GRFlood:

conda install -c defaults -c conda-forge GRFlood

Install from GitHub

To install the development version from GitHub using Git, run the following command in your terminal:

pip install git+https://github.com/callback21/GRFlood

Colaboratory

Colaboratory lets you connect to a local runtime using Jupyter. This allows you to execute code on your local hardware and have access to your local file system.

• Step 1: Install Jupyter
  Install Jupyter on your local machine.

• Step 2: Install and enable the jupyter_http_over_ws jupyter extension (one-off)
  The jupyter_http_over_ws extension is authored by the Colaboratory team and available on GitHub.

pip install jupyter_http_over_ws
jupyter serverextension enable --py jupyter_http_over_ws

• Step 3: Start server and authenticate
  New notebook servers are started normally, though you will need to set a flag to explicitly trust WebSocket connections from the Colaboratory frontend. Once the server has started, it will print a message with the initial backend URL used for authentication. Make a copy of this URL as you'll need to provide this in the next step.

jupyter notebook \
  --NotebookApp.allow_origin='https://colab.research.google.com' \
  --port=8888 \
  --NotebookApp.port_retries=0

• Step 4: Connect to the local runtime
  In Colaboratory, click the 'Connect' button and select 'Connect to local runtime…'. Enter the URL from the previous step in the dialogue that appears and click the 'Connect' button. After this, you should now be connected to your local runtime.

Upgrade GRFlood

If you ha ve installed GRFlood before and want to upgrade to the latest version, you can run the following command in your terminal:

pip install -U GRFlood

If you use conda, you can update GRFlood to the latest version by running the following command in your terminal:

conda update GRFlood