Installation

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 with Docker

$ 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 with Docker

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

šŸ‘‰ Run your Python scripts with Docker

$ 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.

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

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