openLCA IPC API map

Reference map for client, search, data, systems, calculation, results, contributions, uncertainty, parameters, and export modules.

OLCAClient

python

from openlca_ipc import OLCAClient

with OLCAClient(port=8080, read_only=True) as client:
    assert client.test_connection()

OLCAClient is the high-level entry point. Its module attributes keep discovery, model construction, calculation, analysis, uncertainty, parameters, and export separated.

Module map

Attribute	Responsibility	Representative methods
client.search	Search and discovery	find_flows, find_flow, find_processes, find_providers, find_impact_method, get_by_name
client.data	Create flows/processes/exchanges	create_product_flow, create_process, create_exchange
client.systems	Product systems	create_product_system, auto-complete helpers
client.calculate	Calculation and comparison	simple_calculation, compare_systems
client.results	Result extraction	get_total_impacts, get_inventory, get_normalized_impacts, get_weighted_impacts, get_total_requirements, get_sankey
client.contributions	Contribution analysis	get_top_contributors, get_contribution_tree
client.uncertainty	Uncertainty	run_monte_carlo, compare_with_uncertainty
client.parameters	Parameters/scenarios	run_scenario_analysis, create_parameter_redef
client.export	Export	export_to_csv, export_to_excel

Agent and automation layer

ResultSummary and EntitySummary for compact structured results.
CalculationContext for auditable calculation context.
Structured OLCAError types with recoverability hints.
health_check(client) for connection and database checks.
OLCAClient(read_only=True) to block writes at the Python layer.

Result lifecycle

python

result = client.calculate.simple_calculation(system, method)
try:
    impacts = client.results.get_total_impacts(result)
finally:
    result.dispose()

Warning

Dispose live results after extraction. Repeated calculations without disposal can grow openLCA memory usage.