Skip to content

Configuration

VoLCA is configured through a TOML file, typically named volca.toml. Pass it to any command with --config volca.toml.

Top-level scalar fields (such as geographies) must come before any [section] or [[array-of-tables]] header. After a header, every key is parsed as a member of that section — and keys the schema does not recognise are silently dropped, so watch field names closely.

geographies = "data/geographies.csv" # required for regionalized LCIA lookups
[server]
port = 8080
host = "127.0.0.1" # bind address; use "0.0.0.0" to listen on all interfaces
password = "secret" # optional — if set, all API requests require auth
FieldDefaultDescription
port8080HTTP port
host127.0.0.1Bind address; "0.0.0.0" exposes the server on all interfaces
passwordIf set, requires Authorization: Bearer <password> or --password flag

Each database is a [[databases]] entry. VoLCA supports EcoSpold 2, EcoSpold 1, SimaPro CSV, ILCD, and Brightway Excel formats. The format is detected from the file extension and contents — there is no format field.

[[databases]]
name = "ecoinvent" # identifier used in the --db flag
path = "/data/ecoinvent-3.10" # directory or archive with the data files
load = true # load at startup (false = available but not pre-loaded)
[[databases]]
name = "agribalyse"
path = "/data/agribalyse4.csv"
load = true
depends = ["ecoinvent"] # cross-database linking (flows resolved against ecoinvent)
FieldDescription
nameUnique identifier; used as --db NAME in the CLI
displayNameHuman-readable name (defaults to name)
pathDirectory or file path to the data
loadtrue = load at startup; false = available on demand
defaulttrue marks this as the default database
dependsList of database names for cross-database flow linking
FormatExtension / structure
EcoSpold 2Directory or .7z/.zip of .spold files
EcoSpold 1.xml file (older format)
SimaPro CSV.csv or .csv.zip file
ILCDDirectory with processes/ and flows/ subdirectories
Brightway ExcelSingle .xlsx file (Brightway/bw2io layout)

Methods are uploaded separately via volca method upload or pre-configured here.

[[methods]]
name = "EF3.1"
path = "/data/EF3.1" # directory or .zip of ILCD method XML files
active = true # default true; set false to keep it unloaded

Flow synonyms help VoLCA match biosphere flows across databases and methods that use different naming conventions. Each CSV has a name1,name2 header and one synonym pair per row.

[[flow-synonyms]]
name = "default"
path = "/data/flow-synonyms.csv"
active = true

Maps compartment names to a canonical set for cross-database flow matching.

[[compartment-mappings]]
name = "default"
path = "/data/compartments.csv"
active = true

Custom unit conversion tables.

[[units]]
name = "default"
path = "/data/units.csv"
active = true

A vendored PubChem snapshot that widens the flow-mapping suggester’s recall. See Flow Mapping Audit.

chem-synonyms = "data/chem_synonyms.csv"

Named filter shortcuts that appear in the Activities search dropdown. Each preset applies one or more { system, value, mode } classification filters (mode is "exact" or "contains").

[[classification-presets]]
name = "food"
label = "Food products"
filters = [
{ system = "ISIC rev.4 ecoinvent", value = "01", mode = "contains" },
{ system = "ISIC rev.4 ecoinvent", value = "10", mode = "contains" },
]
geographies = "data/geographies.csv"
[server]
port = 8080
[[databases]]
name = "ecoinvent"
path = "/data/ecoinvent-3.10-cutoff"
load = true
[[databases]]
name = "agribalyse"
path = "/data/agribalyse4.csv"
load = true
depends = ["ecoinvent"]
[[methods]]
name = "EF3.1"
path = "/data/EF3.1"
active = true
[[flow-synonyms]]
name = "default"
path = "/data/flow-synonyms.csv"
active = true