canvod.utils API reference¶

Compute SHA256 hash of a GNSS data file's content.

Uses first 16 characters of the SHA256 hexdigest for a compact hash.

Parameters:

Returns:

Examples:

>>> from pathlib import Path
>>> hash_val = file_hash(Path("data.rnx"))
>>> len(hash_val)
16

Extract GPS week from various GNSS product filenames.

Parameters:

Returns:

Raises:

Examples:

>>> from pathlib import Path
>>> week = get_gps_week_from_filename(Path("igs12345.sp3"))

Check if a variable can be converted to float.

Parameters:

Returns:

Examples:

>>> isfloat("3.14")
True
>>> isfloat("hello")
False
>>> isfloat(42)
True

Get the installed canvod-utils package version.

Tries importlib.metadata first, which resolves correctly for any install type (wheel, sdist, or editable). Falls back to walking up from this file's location looking for a pyproject.toml -- this only ever succeeds inside an editable/dev source checkout, since a built wheel's site-packages never ships pyproject.toml. Without the importlib.metadata path first, every store write from a non-editable install (a real PyPI release, or a git-sourced install like the demo notebooks use) raised FileNotFoundError here, since callers pass no explicit pyproject_path and expect this to just work.

Parameters:

Returns:

Examples:

>>> version = get_version_from_pyproject()
>>> print(version)  # e.g., "0.1.0"

The local file of the file at url, fetched once per run.

The URL is checked with :func:parse_remote_url. If the run already fetched it, in this process or another process of the run, that file is returned. Otherwise the file is fetched and given to check; only if check returns is it written into :func:run_folder.

Parameters:

Returns:

Raises:

Check that url is a raw file link in a GitHub repository.

Parameters:

Returns:

Raises:

Whether a setting is a URL rather than a name or a local path.

Parameters:

Returns:

The form of a setting that may be recorded: a URL's file name.

Parameters:

Returns:

text with each http(s) link replaced by what may be recorded.

For text that is recorded, such as an error kept in the run history. Every link is replaced, not only raw file links: a message about a refused link quotes it in other forms too (a GitHub page, another host).

Parameters:

Returns:

The folder of this run's fetched files, created if missing.

A new folder in the system's temporary folder that only its owner can read, removed when the process that made it ends. Worker processes started after it was made use the same folder (it is named in the environment variable CANVODPY_RUN_FOLDER), so they read the files the run fetched and leave its removal to the run.

Returns:

Return the run_id bound to the current context, if any.

Bind run_id to the current context.

Parameters:

Returns:

Reset RUN_ID to its previous value.

Return a run_id for site_name: the site, the start time in UTC, a random part.

The random part keeps run IDs apart when two machines start a run of one site in the same second; each machine has its own run history, so neither can number its run against the other.

Parameters:

Returns:

Decorator form of :func:stage_timer.

Emit one stage_timing event for a duration measured by the caller.

For code that measures several stages from one set of checkpoints instead of one block per stage. The stage counts toward the run summary like a :func:stage_timer block.

Parameters:

Emit a run_summary event: per-stage breakdown for the current run.

The breakdown covers the stages timed in the main process (in canVODpy: writing the GNSS store, computing and writing VOD); the stages of the worker processes are only in the log. Called at the end of a successful run and also from the crash-handling path in cli/run.py, so a partial summary exists even for a run that later failed -- showing how far it got before dying.