Skip to content

Installation

Virtual environment

As for all python packages, we recommend installing into a virtual environment (to conserve system integrity as for python installs). This is especially true if you plan on using the GUI directly on the AQG laptop. If you use or plan to use different python verions, we recommend pyenv. Site note: Pyenv is already installed on AQG laptops as it is used for AQG GUI based processing and operations.

Setting up a virtual environment (with pythons standard venv option):

    # setup
    $ python -m venv nameOfEnvironment

    # activate (Windows)
    $ nameOfEnvironment\Scripts\activate

    # activate (Linux/Mac)
    $ source nameOfEnvironment/bin/activate

Overview of install options

There are several options to install gravitools, depening on your needs and the desired version.

Source Version Link
PyPI stable https://pypi.org/project/gravitools/
conda-forge stable https://anaconda.org/channels/conda-forge/packages/gravitools/overview
git development https://gitlab.opencode.de/bkg/gravitools

Installing

Standard package

Latest stable release from PyPI:

    $ pip install gravitools

Latest stable release from conda-forge:

    $ conda install gravitools --channel conda-forge

Development version from git repository:

    $ pip install git+https://gitlab.opencode.de/bkg/gravitools.git

Standard package + dashboard

From PyPI:

    $ pip install 'gravitools[dashboard]'

From conda-forge:

    $ conda install gravitools-dashboard --channel conda-forge

First installation / usage of dashboard

If an error is shown when starting the dashboard This application failed to start because no Qt platform plugin could be initialized., there is a missing development library of the underlying operating system (usually Linux Debian). Install the missing library via the command below:

    $ sudo apt-get install -y libxcb-cursor-dev

Standard package + building documentation locally

Only possible from PyPI:

    $ pip install 'gravitools[docs]'

Standard package + running unit tests

Only possible from PyPI:

    $ pip install 'gravitools[test]'

Warning

After successfuly installation, please run the commandline command download_eop_data. This will download necessary Earth Orientation Data (EOP) to a local directory. Without this data, the package will not work properly. You can also do this download manually, please see the EOP documenation.

Dependencies

for AQG dashboard

for documentation

for unit tests