Python API Reference

The package root exports the following maintained names:

Name	Purpose
`__version__`	Installed GeoSC version.
`GeoLiftAnalyzer`	File-based or direct-data SparseSC analysis façade.
`load_config`	Load YAML or JSON and optionally validate the common config contract.
`load_and_prepare_data`	Prepare a long input CSV for inference.
`process_sparse_sc_results`	Convert a SparseSC result into result and diagnostic dictionaries.
`plot_actual_vs_synthetic`	Plot observed and synthetic outcome paths.
`validate_geolift_dependencies`	Check required import availability.
`GeoLiftConfigError`	Configuration error.
`GeoLiftDataError`	Data loading or panel error.
`GeoLiftResultsError`	SparseSC result-processing error.
`GeoLiftPlotterError`	Plot construction error.

Import from geolift:

from geolift import GeoLiftAnalyzer, load_config

Specialist classes are available from their modules rather than the package root:

from geolift.donor_evaluator import DonorEvaluator
from geolift.power import SparseSCPowerCalculator

`GeoLiftAnalyzer`

Use GeoLiftAnalyzer(config_path=..., data_path=..., config=...) for file mode. The optional config mapping overrides top-level keys after file loading. Use the constructor’s direct-data arguments for an already prepared wide outcome panel. run_analysis() returns the main result mapping and writes artefacts for file-based runs. plot_results() writes the maintained inference plot.

Stability boundary

The table above describes the public root exports declared by geolift.__all__. Other modules are usable but may have a narrower compatibility contract. The vendored sparsesc package is not a GeoSC public API.