Ga naar inhoud

Productie-API

Zie Python gebruiken voor voorbeelden en productiecommando's voor het gedeelde gedrag.

Auto's

Produce an area with complete CBS-buurt context.

Parameters:

Name Type Description Default
data_store DataStore

Source and production locations.

None
area str or Area or ProductionArea

Input selection: Nederland, a named polygon or water authority code.

nederland
write_geoparquet bool

Write a GeoParquet companion, default True.

True
run_id str

Unique production run, default a UTC timestamp.

None
resume bool

Reuse or rebuild a compatible existing run.

False
overwrite bool

Reuse or rebuild a compatible existing run.

False
refresh_sources bool

Refresh sources for a new run; default reuse.

False
offline bool

Require local source data without network access.

False
preparation SourcePreparation

Shared source policy for nested productions.

None

Returns:

Type Description
Path

Produced GeoPackage; complete selected buurten are retained.

Inwoners

Produce an area with complete CBS-buurt context.

Parameters:

Name Type Description Default
data_store DataStore

Source and production locations.

None
area str or Area or ProductionArea

Input selection: Nederland, a named polygon or water authority code.

nederland
write_geoparquet bool

Write a GeoParquet companion, default True.

True
run_id str

Unique production run, default a UTC timestamp.

None
resume bool

Reuse or rebuild a compatible existing run.

False
overwrite bool

Reuse or rebuild a compatible existing run.

False
refresh_sources bool

Refresh sources for a new run; default reuse.

False
offline bool

Require local source data without network access.

False
preparation SourcePreparation

Shared source policy for nested productions.

None

Returns:

Type Description
Path

Produced GeoPackage; complete selected buurten are retained.

Afwateringseenheden

Produce complete tile results using objects from every relevant authority.

Parameters:

Name Type Description Default
data_store DataStore

Source and output locations.

None
area str or Area or ProductionArea

Input selection; results are not clipped to this boundary.

nederland
workers int

Override the configured number of processes.

None
run_id str

Unique output run, default a UTC timestamp.

None
resume bool

Reuse or rebuild a compatible existing run.

False
overwrite bool

Reuse or rebuild a compatible existing run.

False
refresh_sources bool

Refresh sources for a new run, or require local sources.

False
offline bool

Refresh sources for a new run, or require local sources.

False
preparation SourcePreparation

Shared source policy for nested productions.

None

Returns:

Type Description
Path

Combined afwateringseenheden GeoPackage.

Functioneel landgebruik

Produce functional land use with building companions for an area.

Parameters:

Name Type Description Default
data_store DataStore

Configured source and processed-data locations.

None
area Area

Named input area or water authority code; complete intersecting tiles are retained.

nederland
workers int

Override settings.functioneel_landgebruik_workers; may change on resume.

None
building_context_m float

Prepared neighbour distance needed for subsequent building sampling.

5.0
mapping_csv Path

Classification table and prepared BGT override. Other sources use the datastore.

None
bgt_path Path

Classification table and prepared BGT override. Other sources use the datastore.

None
run_id str

Output run name, default a UTC timestamp.

None
resume bool

Explicitly reuse or rebuild a compatible run. Existing inputs are checked.

False
overwrite bool

Explicitly reuse or rebuild a compatible run. Existing inputs are checked.

False
refresh_sources bool

Refresh sources for a new run, or require local inputs without downloads.

False
offline bool

Refresh sources for a new run, or require local inputs without downloads.

False
preparation SourcePreparation

Shared source policy for nested productions.

None

Returns:

Type Description
Path

The functional-land-use COG in the area-specific production folder.

DEM

Resolve suitable land use, prepare sources and produce an area DEM.

Parameters:

Name Type Description Default
area str or Area or ProductionArea

Shared input selection; complete tile outputs are retained.

nederland
landuse_run Path

Explicit completed land-use production. Otherwise discover or produce it.

None
data_store DataStore

Source caches and default production locations.

None
output_root Path

Override the DEM output location for Python callers. The CLI instead configures the datastore for both DEM and dependent productions.

None
ahn_vrt Path

Explicit AHN mosaic. Otherwise prepare the required cached AHN tiles.

None
workers int

Override configured counts for tile and building processes.

None
building_workers int

Override configured counts for tile and building processes.

None
config DemConfig

Interpolation and building elevation settings.

None
run_id str

Unique run name, default a UTC timestamp.

None
resume bool

Reuse or rebuild a compatible existing run.

False
overwrite bool

Reuse or rebuild a compatible existing run.

False
refresh_sources bool

Refresh sources for a new run, or require locally available sources. Explicit source overrides are not refreshed.

False
offline bool

Refresh sources for a new run, or require locally available sources. Explicit source overrides are not refreshed.

False
preparation SourcePreparation

Shared source policy for nested productions.

None

Returns:

Type Description
Path

Validated DEM GeoTIFF. A Float32 companion is also produced.

Gebieden

Resolve a shared input selection, preparing its boundary when needed.

Parameters:

Name Type Description Default
area str or Area or ProductionArea

Named polygon, Nederland, or a water authority code.

required
store DataStore

Source cache locations.

required
preparation SourcePreparation

Reuse, refresh and offline policy.

required

Returns:

Type Description
ProductionArea

Nonempty polygon geometry in settings.crs.

Bases: StrEnum

Built-in names retained for Python callers.

Logging

Collect production logs without permanently changing caller handlers.

Parameters:

Name Type Description Default
debug bool

Include diagnostic messages in the run file, default False.

False

Yields:

Type Description
None

Active logging session. The first production owns productie.log; nested productions and worker processes share its queue and writer. The root logger is left untouched and package handlers are restored.

Redactie: AI