Skip to main content

gini-doctor

Answers one question: is this machine able to run GINI, and if a machine next to it can, what is different?

pipx install gini-doctor      # or: pip install --user gini-doctor
gini-doctor                   # a menu of probe groups

It probes the container engine and which compose provider actually answers, the rootless prerequisites that fail late (subuid mapping, XDG_RUNTIME_DIR, lingering, cgroup delegation, and whether podman's storage still matches /etc/subuid), registries and stored credentials, the interpreter that really runs gBuilder and the X libraries Qt needs, the GINI images, a live container round trip, and — for the Machine Lab feeling sluggish — CPU governor, thermal throttling and a direct measurement of how steady the lab's live feed is.

The part that matters with more than one machine

A single report says less than a comparison. --fanout collects them over ssh and prints only the fields on which the machines disagree:

printf '%s\n' lab-01 lab-02 lab-03 > hosts.txt
gini-doctor --fanout hosts.txt reports/
gini-doctor --compare reports/*.txt

Nothing has to be installed on those hosts: --fanout pipes the script itself over ssh.

Run it as the user who runs gBuilder, not as root — subuid mappings, XDG_RUNTIME_DIR and lingering are per-user, and a root report describes a machine nobody uses.

No dependencies, deliberately

The machine that needs a doctor is one where something is already wrong, so anything this had to install first is a way for it to be unavailable exactly when it is wanted. It does not depend on gini-core, and emphatically not on gini-toolkit, which carries PySide6 — checking thirty lab machines should not mean installing Qt on them.

The engine is a POSIX shell script (sh, dash and busybox ash all run it) shipped inside the wheel; the gini-doctor command hands it to sh. So the same file runs from a pipx install, from a git checkout, or piped over ssh onto a machine with nothing installed at all — including straight off the repository:

curl -fsSL https://raw.githubusercontent.com/citelab/gini/master/doctor/src/gini_doctor/gini-doctor.sh | sh

Where the rest is written up

What a differing field means and what to do about it: docs/LAB_DIAGNOSIS.md.

Metadata

Release files for gini-doctor 6.18.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gini-doctor 6.18.3
File Size Uploaded
gini_doctor-6.18.3.tar.gz 18.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gini-doctor 6.18.3
File Interpreter ABI Platform
gini_doctor-6.18.3-py3-none-any.whl Python 3 none any Details

Total release size: 36.6 kB

Release files / gini_doctor-6.18.3.tar.gz

Download URL gini_doctor-6.18.3.tar.gz
Size 18.6 kB
Tags Source
SHA-256 checksum
How to use checksums
e93ff8bf94aec8b3688e99e95c43b96150f4bfa6b598d5fddb0f004ac39a3b7a
BLAKE2b-256 checksum
How to use checksums
5345151d4ad8c5f8c2460f2aec7b1b051f5403f3df6e3300ac8399dbfa764d00
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.

Transparency log

Release files / gini_doctor-6.18.3-py3-none-any.whl

Download URL gini_doctor-6.18.3-py3-none-any.whl
Size 18.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6ee72c6a026556837b1545db2813d0807fc2731094de231d26dcc7d901d5e3d
BLAKE2b-256 checksum
How to use checksums
38c866564705ce2c5343d508574c027873de37f099d52f8bf964eb7154553169
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

6.18.3 This release

2 release files

6.18.2

2 release files

6.18.1

2 release files

6.18.0

2 release files

6.17.0

2 release files

6.15.5

2 release files

6.15.4

2 release files

6.15.3

2 release files

6.15.2

2 release files

6.15.1

2 release files

6.15.0

2 release files

6.14.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page