Skip to content

Troubleshooting

Dan Lee-Odinson edited this page Jun 15, 2026 · 1 revision

Troubleshooting

verify_paper3.py aborts: "pinned to orbital-thermal==1.0.0; found 0.8.6"

Your editable install metadata is stale (common after pulling a new release in a long-lived checkout or Codespace). Refresh it:

python -m pip install -e .
python -c "from importlib.metadata import version; print(version('orbital-thermal'))"   # 1.0.0

TypeError: ... missing ... 'assume_sun_shielded'

sink.*, transient.simulate, and transient.averaging_bias require the keyword assume_sun_shielded=True (no default, by design). Add it to the call.

RuntimeError: averaging_bias: result not certified

The transient did not reach a fully certified periodic steady state, so the Jensen/peak metrics would be unreliable. Increase the march length and/or resolution:

transient.averaging_bias(..., n_orbits=120, max_orbits=120, steps_per_orbit=1440)

To inspect an uncertified run instead of raising, pass require_convergence=False; the returned dict still carries all diagnostics.

RuntimeError: RK4 stage temperature ... is non-finite or <= 0 K

The timestep is too large for the heat capacity at that state (an explicit-integration instability). Increase steps_per_orbit or areal_heat_capacity. A RuntimeWarning about the timestep exceeding the radiative time constant is the early signal.

"transient did not resolve the intra-orbit forcing" warning / time_discretization_converged=False

The grid is too coarse to resolve the orbital forcing. Increase steps_per_orbit (and n_orbits/max_orbits so the refined grids also converge). The certificate is intentionally conservative (time_safety_factor, default 2.0).

ImportError: orbital_thermal.fluids requires CoolProp

The ammonia coolant screen needs the optional dependency. Install the extra:

python -m pip install -e ".[fluids]"

Everything except orbital_thermal.fluids works without CoolProp.

Figures: FileNotFoundError writing to results/figures/

Run the plot scripts from the repository root so the relative results/figures/ path resolves (the scripts also create the directory if missing).

pytest: command not found or plotting scripts fail with ModuleNotFoundError: matplotlib

The core and fluids installs do not include all development tools. Install the dev extra:

python -m pip install -e ".[dev]"

verify_paper3.py reports a version other than 1.0.0 after installing correctly

The script is pinned to the published release. Confirm that the repository checkout itself is also on the v1.0.0 tag:

git fetch --tags
git checkout v1.0.0
python -m pip install -e ".[dev]"

Use the moving main branch for current development, not for strict reproduction of the archived v1.0.0 paper-three results.