Skip to main content

GeoCopilot: a Codex-powered geospatial research agent for JupyterLab

Project description

GeoCopilot for JupyterLab

GeoCopilot is a Codex-powered geospatial research agent embedded in the right side of JupyterLab. The Python distribution installs all three parts together:

  • the prebuilt JupyterLab 4 frontend extension;
  • the Jupyter Server backend and notebook execution tools;
  • the bundled OpenGMS platform skill, activated only by an explicit user request.

Install

GeoCopilot requires Python 3.9 or later, JupyterLab 4, Node.js, and the Codex CLI.

npm install -g @openai/codex
python -m pip install opengeolab-geocopilot

Configure the provider before starting JupyterLab:

export OPENAI_API_KEY="your-api-key"
export JUPYTER_AGENT_CODEX_MODEL="gpt-5-mini"
# Optional for an OpenAI-compatible gateway:
export JUPYTER_AGENT_CODEX_BASE_URL="https://example.com/v1"

jupyter lab

The package automatically enables its Jupyter Server Extension. Verify the installation with:

jupyter labextension list
jupyter server extension list
opengms-notebook --help

Install In A Docker Image

For an existing JupyterLab 4 image, install the Codex CLI and this package during the image build:

RUN npm install -g @openai/codex \
 && python -m pip install --no-cache-dir opengeolab-geocopilot==0.2.0

API keys and provider URLs should be injected at container startup rather than stored in the image. When OpenGMS model or data-method services are used, set NODEJS_BACKEND_URL to the OpenGeoLab backend address reachable from the container.

Build A Release

Install release tooling and run the checked release builder:

python -m pip install -e ".[release]"
./scripts/build-release.sh

The wheel and source archive are written to dist/<version>/. Test an unpublished release with a fresh environment or TestPyPI before uploading it to PyPI.

Publish

Create an API token in PyPI and keep it outside the repository:

export TWINE_USERNAME=__token__
export TWINE_PASSWORD="pypi-your-token"
python -m twine upload dist/0.2.0/*

After publication, downstream systems only need the installation command shown above. A new package version must be published for every update because PyPI does not allow replacing an existing release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

opengeolab_geocopilot-0.2.0.tar.gz (235.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

opengeolab_geocopilot-0.2.0-py3-none-any.whl (180.0 kB view details)

Uploaded Python 3

File details

Details for the file opengeolab_geocopilot-0.2.0.tar.gz.

File metadata

  • Download URL: opengeolab_geocopilot-0.2.0.tar.gz
  • Upload date:
  • Size: 235.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for opengeolab_geocopilot-0.2.0.tar.gz
Algorithm Hash digest
SHA256 49798628bc16bd3786703cb99347754d744d60beb58fc0cff32a94012f8a0369
MD5 b0513444b89be5cabb52907e41340d9e
BLAKE2b-256 f912ad4ed6fbe497ed1909a2f25448baa328c2fd9641b1b2708711a60753da9a

See more details on using hashes here.

File details

Details for the file opengeolab_geocopilot-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for opengeolab_geocopilot-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9be254ce78337720a0e3e72cefc18167f1feee5da9d71d18397531b5e82b3660
MD5 a3ec34f427c10375020cd028e01a9d22
BLAKE2b-256 50aa46ed805b7f4540adcaf47232a50e60a43549fff715cc4b2c33dac03dac07

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page