This page describes how to install the Meridian GeoX library. It can be
installed by itself, or alongside the Meridian MMM library.

## Prerequisites and system recommendations

**Python requirements**

- Meridian GeoX only: Python \>= 3.10 is required for Meridian GeoX
- Meridian GeoX and Meridian MMM: Python \>= 3.11 is required to use alongside Meridian MMM.

**GPU recommendations**

Meridian GeoX relies on **JAX** for high-performance vectorized computations.
Installing `meridian-geox` will automatically install CPU-based JAX. If you plan
to run heavy simulations or use JAX acceleration for both GeoX and Meridian, we
recommend setting up JAX with GPU support. Refer to the [JAX installation
guide](https://github.com/google/jax#installation) and the [Meridian
installation
guide](https://github.com/google/meridian/blob/main/README.md#install-meridian)
for GPU configurations.

## Install the Meridian GeoX library

To install `meridian-geox`, run the following command to automatically install
the most recent published version from PyPI:

    python3 -m pip install --upgrade meridian-geox

To install or upgrade both `google-meridian` and `meridian-geox` from PyPI, run:

    python3 -m pip install --upgrade 'google-meridian[meridian-geox]'

Alternatively, to install the development version directly from GitHub:

    python3 -m pip install --upgrade git+https://github.com/google/meridian-geox.git

## Use the Meridian GeoX library

You can run the Meridian GeoX code programmatically using sample data with the
getting started
[Colabs](https://github.com/google/meridian-geox/tree/main/meridian_geox/colab).