Reference documentation

Reference documentation of the currently implemeted operations.

Initialisation

Campo([debug])
Campo.add_phenomenon(phenomenon_name)
Campo.create_dataset(filename[, working_dir])
Campo.write([timestep])
Campo.set_time(start, unit, stepsize, ...)
Phenomenon(name)
Phenomenon.add_property_set(pset_name, filename)
Phenomenon.set_epsg(epsg)	Setting Coordinate Reference System (CRS) for the spatial domain

Operations on field or agent properties

Operations

abs(property)	Calculates the absolute value for each object the property values.
exp(property)	Calculates the exponential for each object the property values.
uniform(lower, upper[, seed])	Returns for each object values drawn from a uniform distribution.
where(condition, property1, property2)	returns property1 for true condition, property2 otherwise

Operators

add(self, other)	Addition, equivalent to the + operator.
divide(self, other)	Division, equivalent to the / operator.
equal(self, other)	Equivalent to the == operator.
greater_equal(self, other)	Equivalent to the >= operator.
greater(self, other)	Equivalent to the > operator.
less_equal(self, other)	Equivalent to the <= operator.
less(self, other)	Equivalent to the < operator.
mul(self, other)	Multiplication, equivalent to the * operator.
not_equal(self, other)	Equivalent to the != operator.
power(self, other)	First property raised to the power of the second property.
sub(self, other)	Subtraction, equivalent to the - operator.

Operations on field properties

slope(area_property)
spread(start_locations, frictiondist, friction)	Total friction of the shortest accumulated friction path over a map with friction values from a source cell to cell under consideration