Skip to main content

Installation

GeoSC 0.4.0 supports Python 3.10 to 3.13. Use an isolated virtual environment.

Obtain the wheel or source archive from the private GitHub release. Access requires repository permission. This beta does not establish statistical calibration; review the inference and power limitations before using results.

Install a maintained build

python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install /path/to/geosc-0.4.0-py3-none-any.whl
geosc --help

The build installs both geosc and the compatibility command geolift. It does not include the repository’s data-config/, recipes/, or shapemap/ directories. Supply your own input CSV and YAML files.

Install from a source checkout

git clone https://github.com/tandpds/GeoSC.git
cd GeoSC
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
geosc --help

Source installation makes the shipped synthetic panel and stage configs available under data-config/.

Optional GPU dependency

CuPy is optional and is used only by parts of unseeded power-analysis DGP estimation or generation when the supported GPU path is available. Main SparseSC inference is CPU-based. A configured random_seed disables GPU DGP and generation paths to preserve reproducible draws. Install a CuPy build that matches the local CUDA runtime; for example:

python -m pip install cupy-cuda12x

GeoSC falls back to CPU when the requested GPU path is unavailable. Record the reported dgp_backend and generation_backend; do not infer GPU use from the configuration alone.

Development and documentation

pyproject.toml contains the runtime dependencies and optional tooling. The former duplicated requirements.txt is no longer maintained.

python -m pip install -e ".[dev,docs]"
python -m pytest -q
python -m sphinx -W --keep-going -b html docs docs/_build/html
python scripts/sync_docs_site.py
hugo --source docs-site --panicOnWarning

The tested static-site toolchain is Hugo Extended 0.169.0 with Relearn 9.4.0. Install that theme in a fresh checkout before running Hugo:

git clone --depth 1 --branch 9.4.0 https://github.com/McShelby/hugo-theme-relearn.git docs-site/themes/hugo-theme-relearn

Relearn renders TeX during the build using KaTeX. The previous custom MathJax footer is obsolete. Built HTML and synchronised Hugo content are generated artefacts; edit docs/ first.