Installation

Use Conda (recommended)

The latest stable public release of GPlately can be installed using conda from the conda-forge channel. The following commands will create a new conda environment called my-gplately-conda-env and install GPlately within that environment.

$ conda create -n my-gplately-conda-env
$ conda activate my-gplately-conda-env
$ conda install -c conda-forge gplately

Note

If conda gets stuck while solving the environment during the installation of GPlately, you can try to use micromamba instead.

Use Pip

GPlately can also be installed using pip.

👉 Install the latest stable public release from PyPI.

$ pip install gplately

👉 Install from the GitHub GPlately repository (if you need the latest code changes on GitHub).

$ pip install git+https://github.com/GPlates/gplately.git

👉 Install from a local folder (if you need local code changes).

$ git clone https://github.com/GPlates/gplately.git gplately.git
$ cd gplately.git
$ git checkout master
$ git pull
$ MAKE YOUR LOCAL CODE CHANGES HERE ...
$ pip install -e .

Note

✏️ The pip install -e . command installs GPlately in editable mode.

Use Docker

👉 Run GPlately notebooks within a Docker container.

$ docker pull gplates/gplately
$ docker run --rm -ti -p 8888:8888 gplates/gplately

The commands above will start a Jupyter Notebook server on port 8888. Open this link http://localhost:8888 in a web browser.

👉 Run GPlately commands within a Docker container.

$ docker run gplates/gplately gplately --version
$ docker run gplates/gplately gplately --help

👉 Run your Python scripts within a Docker container.

$ docker run -it --rm -v THE_FULL_PATH_TO_YOUR_SCRIPT_FOLDER:/ws -w /ws gplates/gplately python my_script_to_run.py

Note

Replace THE_FULL_PATH_TO_YOUR_SCRIPT_FOLDER with the full path to the folder containing your script file. In PowerShell, you can use “$PWD” if your script is in the current working directory. On Linux or macOS, you can use `pwd` instead.

In certain shell environments, using a relative path may also work. You can try the following command to mount your current working directory to /ws.

$ docker run -it --rm -p 8888:8888 -v .:/ws -w /ws gplates/gplately

GPlately Docker images are available at both Docker Hub and GitHub Container Registry.

• https://hub.docker.com/r/gplates/gplately/tags

• https://github.com/GPlates/gplately/pkgs/container/gplately

Visit this Docker README page for more details about using Docker with GPlately.