seims.scenario_analysis.spatialunits.scenario Namespace Reference

Classes
class	SUScenario

Functions
def	select_potential_bmps (unitid, suitbmps, unitsinfo, unit2gene, ind, unit='SLPPOS', method='SUIT', bmpgrades=None, tagnames=None # type:Optional[List[Tuple[int, AnyStr]]] # for SLPPOS)
def	initialize_scenario (cf, input_genes=None)
def	initialize_scenario_with_bmps_order (cf, opt_genes, input_genes=False)
def	scenario_effectiveness (cf, ind)
def	scenario_effectiveness_with_bmps_order (cf, ind)
def	main_multiple (eval_num)
def	main_single (sceid, gene_values)
def	main_manual (sceid, gene_values)
def	main_manual_bmps_order (sceid, gene_values)

Detailed Description

Scenario for optimizing BMPs based on slope position units.

    @author   : Liangjun Zhu, Huiran Gao

    @changelog:
    - 16-10-29  - hr - initial implementation.
    - 17-08-18  - lj - redesign and rewrite.
    - 18-02-09  - lj - compatible with Python3.

Function Documentation

initialize_scenario()

def seims.scenario_analysis.spatialunits.scenario.initialize_scenario	(		cf,
			input_genes = None
	)

Initialize gene values

initialize_scenario_with_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.initialize_scenario_with_bmps_order	(		cf,
			opt_genes,
			input_genes = False
	)

Initialize gene values

main_manual()

def seims.scenario_analysis.spatialunits.scenario.main_manual	(		sceid,
			gene_values
	)

Test of set scenario manually.

main_manual_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.main_manual_bmps_order	(		sceid,
			gene_values
	)

Test of set scenario manually.

main_multiple()

def seims.scenario_analysis.spatialunits.scenario.main_multiple

(

eval_num

)

Test of multiple evaluations of scenarios.

main_single()

def seims.scenario_analysis.spatialunits.scenario.main_single	(		sceid,
			gene_values
	)

Test of single evaluation of scenario.

scenario_effectiveness()

def seims.scenario_analysis.spatialunits.scenario.scenario_effectiveness	(		cf,
			ind
	)

Run SEIMS-based model and calculate economic and environmental effectiveness.

scenario_effectiveness_with_bmps_order()

def seims.scenario_analysis.spatialunits.scenario.scenario_effectiveness_with_bmps_order	(		cf,
			ind
	)

Run SEIMS-based model and calculate time extended economic and environmental effectiveness.

select_potential_bmps()

def seims.scenario_analysis.spatialunits.scenario.select_potential_bmps	(		unitid,
			suitbmps,
			unitsinfo,
			unit2gene,
			ind,
			unit = 'SLPPOS',
			method = 'SUIT',
			bmpgrades = None,
			tagnames = None  # type: Optional[List[Tuple[int, AnyStr]]] # for SLPPOS
	)

Select potential BMPs for specific spatial unit.