searchindex.js

Search.setIndex({"docnames": ["demeter", "demeter.change", "demeter.demeter_io", "demeter.tests", "demeter.weight", "index", "modules", "readme"], "filenames": ["demeter.rst", "demeter.change.rst", "demeter.demeter_io.rst", "demeter.tests.rst", "demeter.weight.rst", "index.rst", "modules.rst", "readme.rst"], "titles": ["demeter package", "demeter.change package", "demeter.demeter_io package", "demeter.tests package", "demeter.weight package", "Welcome to Demeter\u2019s documentation!", "demeter", "Demeter"], "terms": {"chang": [0, 2, 6], "expans": [0, 5, 6, 7], "apply_expans": [0, 1], "intensif": [0, 5, 6, 7], "apply_intensif": [0, 1], "diff_diagnost": [0, 1], "reg_metric_it": [0, 1], "demeter_io": [0, 6], "reader": [0, 6], "validationexcept": [0, 2, 6], "csv_to_arrai": [0, 2], "read_allocation_data": [0, 2], "read_bas": [0, 2], "read_gcam_fil": [0, 2], "read_gcam_land": [0, 2], "to_arrai": [0, 2], "to_dict": [0, 2], "to_list": [0, 2], "writer": [0, 6], "arr_to_ascii": [0, 2], "array_to_csv": [0, 2], "lc_timestep_csv": [0, 2], "max_ascii_rast": [0, 2], "save_arrai": [0, 2], "to_netcdf_lc": [0, 2], "to_netcdf_yr": [0, 2], "write_transit": [0, 2], "test": [0, 2, 6], "test_model_output": [0, 6], "testoutput": [0, 3], "comp_2010": [0, 3], "comp_2015": [0, 3], "gcamwrapper_df": [0, 3], "run_dir": [0, 3, 5, 7], "test_proj_outputs_using_arg": [0, 3], "weight": [0, 6], "kernel_dens": [0, 5, 6, 7], "kerneldens": [0, 4], "apply_convolut": [0, 4], "compute_cell_index": [0, 4], "convolution_filt": [0, 4], "dist_it": [0, 4], "global_system": [0, 4], "prep_arrai": [0, 4], "preprocess_kernel_dens": [0, 4], "handle_single_pft": [0, 4], "read": [0, 2], "config": [0, 2, 5, 7], "ini": [0, 2, 5, 7], "type": [0, 2, 5, 7], "cast": 0, "paramet": [0, 1, 2, 4, 5, 7], "copyright": [0, 1, 2, 4], "c": [0, 1, 2, 3, 4], "2017": [0, 1, 2, 4], "battel": [0, 1, 2, 4], "memori": [0, 1, 2, 4], "institut": [0, 1, 2, 4], "open": [0, 1, 2, 4, 5, 7], "sourc": [0, 1, 2, 4, 5, 7], "under": [0, 1, 2, 4], "licens": [0, 1, 2, 3, 4], "bsd": [0, 1, 2, 3, 4], "2": [0, 1, 2, 3, 4, 5, 7], "claus": [0, 1, 2, 3, 4], "see": [0, 1, 2, 4, 5, 7], "disclaim": [0, 1, 2, 4], "author": [0, 1, 2, 3, 4], "chri": [0, 1, 2, 3, 4], "r": [0, 1, 2, 3, 4], "vernon": [0, 1, 2, 3, 4], "pnnl": [0, 1, 2, 3, 4], "gov": [0, 1, 2, 3, 4], "class": [0, 2, 3, 4], "readconfig": [0, 6], "param": [0, 2, 5, 7], "base": [0, 1, 2, 3, 4, 5, 7], "object": [0, 2, 4], "datetime_format": [0, 6], "y": 0, "m": 0, "d_": 0, "hh": 0, "mm": 0, "ss": 0, "static": 0, "check_exist": [0, 6], "f": [0, 2], "kind": 0, "check": 0, "file": [0, 2], "directori": [0, 2, 5, 7], "exist": [0, 1, 2, 5, 7], "full": [0, 2, 5, 7], "path": [0, 2, 5, 7], "either": [0, 1, 2, 5, 7], "dir": 0, "return": [0, 1, 2, 4], "error": [0, 2, 5, 7], "ck_agg": [0, 6], "aggreg": 0, "level": [0, 2, 3, 5, 7], "1": [0, 1, 2, 3, 5, 7], "onli": [0, 2, 4, 5, 7], "region": [0, 1, 2, 3, 5, 7], "basin": [0, 2, 5, 7], "aez": [0, 2], "ck_t": [0, 6], "t": 0, "st_y": 0, "ed_i": 0, "make": [0, 5, 7], "sure": [0, 5, 7], "time": [0, 2, 5, 7], "step": [0, 2, 5, 7], "fit": 0, "year": [0, 1, 2, 3, 4, 5, 7], "bound": 0, "start": [0, 1, 2, 4], "end": [0, 2], "ck_type": [0, 6], "v": 0, "p": 0, "tp": 0, "ensur": [0, 3], "desir": [0, 1, 5, 7], "convers": 0, "can": [0, 1, 5, 7], "achiev": [0, 1, 5, 7], "valu": [0, 2, 5, 7], "name": [0, 2, 5, 7], "ck_yr": [0, 6], "lower_year": 0, "500": 0, "upper_year": 0, "3000": 0, "i": [0, 1, 2, 4, 5, 7], "four": 0, "digit": 0, "int": [0, 2], "create_dir": [0, 6], "d": [0, 1], "creat": [0, 1, 4], "target": [0, 2, 5, 7], "get_constraint": [0, 6], "get": [0, 2], "list": [0, 1, 2], "valid": [0, 2], "user": [0, 2, 4, 5, 7], "ha": 0, "chosen": 0, "us": [0, 1, 2, 4], "them": 0, "get_outdir": [0, 6], "out": [0, 2], "output": [0, 2, 3, 5, 6, 7], "uniqu": [0, 2, 5, 7], "set_target": [0, 6], "set": [0, 2, 4, 5, 7], "look": 0, "when": [0, 5, 7], "product": [0, 5, 7], "thi": [0, 4, 5, 7], "If": [0, 2, 5, 7], "none": [0, 2], "specifi": 0, "all": [0, 2, 5, 7], "vaild_length": [0, 6], "max_charact": 0, "30": 0, "len": 0, "string": [0, 2, 5, 7], "less": 0, "than": [0, 5, 7], "equal": 0, "max": [0, 2], "length": 0, "valid_integ": [0, 6], "l": 0, "an": [0, 2, 5, 7], "avail": [0, 5, 7], "option": [0, 5, 7], "tupl": 0, "valid_limit": [0, 6], "typ": 0, "fall": 0, "within": [0, 1, 5, 7], "limit": 0, "rang": [0, 5, 7], "accept": 0, "intend": 0, "valid_str": [0, 6], "except": [0, 2], "arg": [0, 2], "appli": [0, 4, 5, 7], "defin": [0, 2, 4, 5, 7], "land": [0, 1, 2, 3], "layer": [0, 1, 2], "predict": 0, "alloc": [0, 2, 3], "data": [0, 1, 2, 3], "yannick": [0, 1, 2, 4], "le": [0, 1, 2, 4], "page": [0, 1, 2, 4, 5], "niquya": [0, 1, 2, 4], "gmail": [0, 1, 2, 4], "com": [0, 1, 2, 4, 5, 7], "applyconstraint": [0, 6], "allreg": [0, 2], "allaez": 0, "final_landclass": [0, 1, 2, 4], "user_year": [0, 2], "ixr_ixm": 0, "allregaez": [0, 2], "spat_region": [0, 1], "allregnumb": [0, 1, 2], "spat_aez": 0, "gcam_landclass": [0, 2], "gcam_regionnumb": [0, 2], "gcam_aez": 0, "gcam_landnam": [0, 2], "gcam_arrai": 0, "gcam_ludata": [0, 2], "ngrid": [0, 4], "constraint_nam": 0, "observed_landclass": [0, 2], "observed_arrai": 0, "spat_ludata": [0, 1], "constraint_fil": 0, "apply_constraints_zero": [0, 6], "occur": [0, 5, 7], "independ": 0, "self": 0, "apply_gcam_constraint": [0, 6], "yr_idx": [0, 1], "gcam_landmatrix": [0, 1], "spat_landmatrix": [0, 1], "ixr_ixm_ixg": 0, "gcam": [0, 1, 2, 5, 7], "target_chang": [0, 1], "per": [0, 2, 5, 7], "metric": [0, 1, 2], "pft": [0, 4], "apply_spat_constraint": [0, 6], "bin": [0, 5, 7], "spatial": [0, 2], "final": [0, 2, 5, 7], "function": [0, 3, 4, 5, 7], "build_gcam_landmatrix": [0, 6], "zero": [0, 2], "arrai": [0, 2, 4], "hous": 0, "summari": 0, "3d": [0, 2], "build_spat_landmatrix": [0, 6], "spat_ludataharm": [0, 1, 2, 4], "conduct": [0, 5, 7], "compile_constraint": [0, 6], "popul": 0, "posit": [0, 2], "0": [0, 2, 3, 5, 7], "reserv": 0, "kernel": [0, 4], "densiti": [0, 4], "ar": [0, 1, 5, 7], "fly": 0, "later": 0, "number": [0, 2, 5, 7], "grid": [0, 1, 2, 4, 5, 7], "cell": [0, 1, 2, 4, 5, 7], "numpi": [0, 2], "empti": [0, 4], "cons_n": 0, "reg_metric_lcs_zip": [0, 6], "lcs_list": 0, "contain": [0, 2, 5, 7], "region_ix": 0, "metric_ix": 0, "cover": [0, 1, 2], "ix": 0, "kwarg": 0, "installsuppl": [0, 6], "example_data_directori": 0, "download": [0, 5, 7], "unpack": 0, "exampl": [0, 5, 7], "supplement": 0, "from": [0, 2, 4, 5, 7], "zenodo": 0, "match": 0, "current": [0, 2, 5, 7], "instal": [0, 5, 7], "distribut": 0, "you": [0, 5, 7], "wish": [0, 2], "must": [0, 5, 7], "write": [0, 2, 5, 7], "enabl": 0, "data_version_url": [0, 6], "3": [0, 2, 3, 5, 7], "http": [0, 5, 7], "org": 0, "record": 0, "7240315": 0, "config_gcam_refer": 0, "zip": 0, "fetch_zenodo": [0, 6], "get_package_data": [0, 5, 6, 7], "str": [0, 2], "email": 0, "initi": [0, 6], "project": [0, 2, 3], "wide": 0, "The": [0, 1, 2, 5, 7], "both": [0, 2], "stdout": 0, "log_format_str": [0, 6], "asctim": 0, "": [0, 2, 7], "levelnam": 0, "messag": 0, "close_logg": [0, 6], "shutdown": 0, "console_handl": [0, 6], "construct": 0, "consol": 0, "handler": 0, "file_handl": [0, 6], "logfil": 0, "write_logfil": 0, "run": [0, 2, 5, 7], "root_dir": 0, "filenam": 0, "extens": [0, 2, 5, 7], "structur": [0, 5, 7], "build_gener": [0, 6], "gener": [0, 5, 7], "cleanup": [0, 6], "clean": 0, "up": [0, 4, 5, 7], "instanc": 0, "execut": [0, 6], "main": 0, "downscal": [0, 1, 5, 7], "routin": 0, "setup": 0, "process_step": [0, 6], "singl": [0, 2], "run_model": [0, 5, 6, 7], "conveni": 0, "wrapper": 0, "sequenti": 0, "demetertonetcdf": [0, 6], "base_year_fil": 0, "start_year": [0, 5, 7], "2005": [0, 3, 5, 7], "end_year": [0, 5, 7], "year_interv": 0, "5": [0, 3, 5, 7], "xmin": 0, "float": [0, 2, 5, 7], "180": [0, 2], "xmax": 0, "ymin": 0, "90": [0, 2], "ymax": 0, "resolut": [0, 2, 4, 5, 7], "05": [0, 2], "regrid_resolut": 0, "project_nam": 0, "im3": 0, "scenario_nam": 0, "demeter_vers": 0, "31": 0, "csv_input": 0, "true": [0, 2, 5, 7], "df": 0, "datafram": [0, 2], "column": [0, 2, 3], "index": [0, 2, 5], "convert": [0, 2, 4], "netcdf": [0, 2, 5, 7], "input": [0, 2, 5, 7], "extract": [0, 2, 5, 7], "compression_paramet": [0, 6], "complevel": 0, "dtype": 0, "float32": 0, "zlib": 0, "generate_regrid_coordin": [0, 6], "coord_min": 0, "coord_max": 0, "ascend": 0, "bool": 0, "decim": [0, 5, 7], "evenli": 0, "space": 0, "coordin": [0, 2, 4], "pair": [0, 2], "lat": [0, 2, 4], "lon": [0, 2, 4], "minimum": 0, "maximum": [0, 1, 2, 5, 7], "descend": 0, "fals": [0, 2], "round": 0, "generate_scaled_coordin": [0, 6], "process_output": [0, 6], "input_file_directori": 0, "output_file_directori": 0, "target_year": 0, "dataset": 0, "where": [0, 1, 2, 5, 7], "store": [0, 5, 7], "its": 0, "should": [0, 5, 7], "written": 0, "xarrai": 0, "formatgcamdatafram": [0, 6], "f_out": 0, "2010": [0, 3, 5, 7], "through_year": 0, "2100": [0, 5, 7], "region_name_field": 0, "gcam_region_nam": 0, "region_id_field": 0, "gcam_region_id": 0, "basin_name_field": 0, "glu_nam": 0, "basin_id_field": 0, "basin_id": [0, 2, 3], "output_to_csv": 0, "gcam_landalloc_field": [0, 6], "gcam_nodes_field": [0, 6], "child": [0, 3], "node": [0, 3], "format": [0, 2, 5, 7], "frame": [0, 2], "gcamwrapp": 0, "categori": [0, 5, 7], "leav": 0, "irrig": [0, 2], "rainf": 0, "well": 0, "manag": 0, "hi": 0, "lo": 0, "separ": [0, 5, 7], "panda": [0, 2], "save": [0, 2, 5, 7], "through": [0, 5, 7], "field": [0, 2, 5, 7], "refer": [0, 2, 5, 7], "id": [0, 2, 5, 7], "glu": 0, "abbrevi": 0, "locat": [0, 2, 5, 7], "databas": [0, 2], "expect": [0, 2, 5, 7], "africa_eastern": [0, 3], "corn_afrcste_irr_hi": [0, 3], "1975": [0, 3], "009381": [0, 3], "1990": [0, 3], "008705": [0, 3], "010365": [0, 3], "012348": [0, 3], "4": [0, 3, 5, 7], "2015": [0, 3], "013194": [0, 3], "demeter_basin_name_field": [0, 6], "demeter_landclass_field": [0, 6], "landclass": [0, 2, 5, 7], "demeter_metric_field": [0, 6], "metric_id": [0, 5, 7], "demeter_regid_field": [0, 6], "region_id": [0, 2, 3, 5, 7], "gcam_landclass_delim": [0, 6], "_": 0, "gcam_region_field": [0, 6], "gcam_unit_field": [0, 6], "unit": [0, 2, 5, 7], "gcam_year_field": [0, 6], "build_basin_dict": [0, 6], "lookup": 0, "dictionari": [0, 2], "comma": [0, 2, 5, 7], "titl": 0, "respect": 0, "basin_nam": 0, "build_regions_dict": [0, 6], "region_nam": [0, 2], "format_land_data": [0, 6], "properti": 0, "format_gcam_data": [0, 6], "produc": 0, "requir": 0, "calcul": [0, 4], "map": [0, 2, 4, 5, 7], "creation": 0, "log": [0, 1, 5, 7], "statist": 0, "method": 0, "determin": 0, "processstep": [0, 6], "step_idx": 0, "write_output": [0, 2, 5, 7], "expansion_pass": [0, 6], "pass": [0, 3], "intense_pass": [0, 6], "pass_num": 0, "first": [0, 1, 2, 5, 7], "specif": 0, "harmon": 0, "sqkm": [0, 5, 7], "n_cell": 0, "n_landclass": [0, 2], "spat_ludataharm_orig": 0, "same": [0, 2], "previou": 0, "cellarea": [0, 2], "area": [0, 2, 5, 7], "each": [0, 2, 5, 7], "celltrunk": 0, "actual": 0, "percentag": 0, "includ": [0, 5, 7], "l_fc": 0, "cellindexresin": [0, 4], "x": [0, 3], "geograph": [0, 2, 4, 5, 7], "latitud": [0, 2, 3, 4, 5, 7], "longitud": [0, 2, 3, 4, 5, 7], "being": [0, 5, 7], "region_coord": 0, "coord": 0, "country_coord": 0, "countri": 0, "luc_ts_luc": 0, "luc_timestep": 0, "transit": [0, 2], "one": [0, 2, 5, 7], "anoth": 0, "select": [0, 5, 7], "prep_step": [0, 6], "prepar": [0, 4, 5, 7], "total": 0, "mai": [0, 5, 7], "due": 0, "water": [0, 3], "inclus": 0, "boundari": 0, "etc": [0, 5, 7], "therefor": 0, "adjust": 0, "sinc": [0, 5, 7], "wai": [0, 1], "addit": 0, "origin": [0, 2], "reg_metric_zip": [0, 6], "allregmetr": 0, "combin": 0, "everi": 0, "yr_reg_metric_zip": [0, 6], "yr_list": 0, "r_m_list": 0, "yr": [0, 1, 2, 4], "harmoni": [0, 6], "between": [0, 1], "kernel_filt": [0, 6], "filter": [0, 2, 4, 5, 7], "prep_bas": [0, 6], "prep_project": [0, 6], "prep_refer": [0, 6], "correspond": [0, 5, 7], "associ": 0, "also": 0, "sort": 0, "set_constraint": [0, 6], "set_step_zero": [0, 6], "disaggreg": 0, "detect": 0, "algorithm": [1, 2, 4], "allregmet": 1, "spat_met": 1, "kernel_vector": [1, 4], "cons_data": 1, "order_rul": [1, 2, 4], "constraint_rul": 1, "transition_rul": 1, "land_mismatch": 1, "spat_ludataharm_orig_step": 1, "pass_numb": 1, "d_regid_nm": 1, "There": 1, "two": [1, 5, 7], "expand": [1, 5, 7], "thei": 1, "do": [1, 4], "expens": 1, "contract": 1, "although": 1, "preferenti": [1, 5, 7], "close": 1, "landcov": 1, "found": [1, 5, 7], "proxim": 1, "intensification_ratio": [1, 5, 7], "control": 1, "ratio": 1, "versu": 1, "intensifi": 1, "until": 1, "reach": 1, "rest": 1, "done": 1, "target_intensif": 1, "repres": [1, 2, 5, 7], "how": [1, 5, 7], "much": 1, "we": 1, "like": 1, "given": [1, 5, 7], "diag_outdir": 1, "reg": 1, "comput": [1, 4], "differ": 1, "observ": [1, 2], "subsequ": 1, "iter": [1, 4], "reg_idx": 1, "metric_idx": 1, "n": [1, 2], "runtim": 2, "csv": [2, 5, 7], "lc_col": 2, "output_level": 2, "delim": 2, "header": [2, 5, 7], "variabl": [2, 5, 7], "default": [2, 5, 7], "lc": 2, "delimit": [2, 5, 7], "sequence_metric_dict": 2, "metric_seq": 2, "region_seq": 2, "logger": [2, 6], "process": [2, 4, 5, 6, 7], "configur": [2, 3], "A": 2, "order": 2, "gcam_data": 2, "start_yr": 2, "end_yr": 2, "timestep": [2, 5, 7], "scenario": [2, 5, 7], "region_dict": 2, "agg_level": 2, "area_factor": 2, "1000": 2, "gcamread": 2, "name_col": 2, "factor": [2, 5, 7], "multipli": [2, 5, 7], "thousand": 2, "km": 2, "follow": [2, 5, 7], "row": [2, 3, 5, 7], "gcam_metr": 2, "db_path": 2, "db_file": 2, "f_queri": 2, "d_basin_nam": 2, "subreg": 2, "crop_water_src": 2, "queri": 2, "subregion": 2, "crop": [2, 5, 7], "xml": 2, "basin_glu_nam": 2, "agg": 2, "irr": 2, "rfd": 2, "km2": 2, "target_index": 2, "slice": 2, "swap": 2, "value_col": 2, "kei": 2, "support": 2, "els": 2, "dict": 2, "retun": 2, "integ": [2, 5, 7], "multipl": 2, "caleb": 2, "j": 2, "braun": 2, "arr": 2, "r_ascii": 2, "xll": 2, "yll": 2, "cellsiz": 2, "25": [2, 3, 5, 7], "nodata": 2, "9999": 2, "ascii": 2, "raster": 2, "2d": 2, "outfil": 2, "lower": 2, "left": 2, "corner": 2, "size": [2, 5, 7], "degre": [2, 5, 7], "out_fil": 2, "spat_coord": [2, 4], "metric_id_arrai": 2, "spat_wat": 2, "fraction": [2, 5, 7], "write_ncdf": 2, "sce": 2, "write_csv": 2, "regrid_r": 2, "out_dir": 2, "alg": 2, "axi": 2, "note": [2, 5, 7], "replac": 2, "nan": 2, "your": [2, 5, 7], "have": [2, 5, 7], "largest": 2, "col": 2, "out_rast": 2, "npy": 2, "spat_lc": 2, "resin": 2, "model": [2, 6], "build": [2, 5, 7], "over": 2, "simul": [2, 5, 7], "n_class": 2, "classic": 2, "map_idx": 2, "n_grid": 2, "py": 3, "high": [3, 5, 7], "remain": 3, "consist": 3, "methodnam": 3, "runtest": 3, "testcas": 3, "integr": [3, 5, 7], "biomassgrass_irr": 3, "biomassgrass_rfd": 3, "biomasstree_irr": 3, "biomasstree_rfd": 3, "tundra": 3, "10": 3, "160": 3, "000000": 3, "75": 3, "11": 3, "12": 3, "149": 3, "155": 3, "163706": 3, "67415": 3, "79": 3, "99": 3, "23": 3, "121": 3, "892015": 3, "125869": 3, "67416": 3, "386234": 3, "67417": 3, "8": 3, "139": 3, "29": 3, "075531": 3, "67418": 3, "195": 3, "451436": 3, "67419": 3, "9": [3, 5, 7], "749": 3, "713579": 3, "67420": 3, "55": 3, "101540": 3, "usa": 3, "biomasstree_usapacnw_rfd_lo": 3, "101541": 3, "101542": 3, "101543": 3, "101544": 3, "101545": 3, "demeter_dev": 3, "argument": 3, "kernel_dist": [4, 5, 7], "pft_map": 4, "kernel_map": 4, "convolut": [4, 5, 7], "indic": [4, 7], "nativ": 4, "distanc": 4, "squar": [4, 5, 7], "assign": [4, 5, 7], "system": [4, 5, 7], "pft_order": 4, "helper": 4, "handl": 4, "convult": 4, "parallel": 4, "oper": 4, "speed": 4, "modul": [5, 6], "search": 5, "rst": [], "u": [], "exclud": [5, 7], "suffix": [], "here": [], "packag": [5, 6, 7], "subpackag": 6, "submodul": 6, "content": 6, "config_read": 6, "constraint": 6, "install_suppl": 6, "ncdf_convers": 6, "preprocess_data": 6, "reconcil": 6, "stage": 6, "test_read": 6, "python": [5, 7], "wa": [5, 7], "built": [5, 7], "futur": [5, 7], "human": [5, 7], "earth": [5, 7], "tradition": [5, 7], "transfer": [5, 7], "esm": [5, 7], "varieti": [5, 7], "biophys": [5, 7], "biogeochem": [5, 7], "flux": [5, 7], "tool": [5, 7], "perform": [5, 7], "translat": [5, 7], "manual": [5, 7], "which": [5, 7], "introduc": [5, 7], "ineffici": [5, 7], "seamless": [5, 7], "repeat": [5, 7], "provid": [5, 7], "lulcc": [5, 7], "directli": [5, 7], "global": [5, 7], "analysi": [5, 7], "commonli": [5, 7], "github": [5, 7], "code": [], "block": [], "bash": [], "pip": [5, 7], "git": [5, 7], "jgcri": [5, 7], "egg": [5, 7], "prompt": [5, 7], "import": [5, 7], "want": [5, 7], "data_dir": [5, 7], "my": [5, 7], "unzip": [5, 7], "local": [5, 7], "machin": [5, 7], "just": [5, 7], "Be": [5, 7], "detail": [5, 7], "custom": [5, 7], "section": [5, 7], "To": [5, 7], "config_fil": [5, 7], "demeter_config": [5, 7], "sever": [5, 7], "begin": [5, 7], "outlin": [5, 7], "describ": [5, 7], "present": [5, 7], "tabl": 7, "descript": [5, 7], "fid": [5, 7], "e": [5, 7], "g": [5, 7], "shrub": [5, 7], "grass": [5, 7], "exact": [5, 7], "spell": [5, 7], "centroid": [5, 7], "sign": [5, 7], "vari": [5, 7], "prefer": [5, 7], "meet": [5, 7], "text": [5, 7], "For": [5, 7], "demeter_class_1": [5, 7], "demeter_class_2": [5, 7], "demeter_class_3": [5, 7], "gcam_class_1": [5, 7], "gcam_class_2": [5, 7], "gcam_class_3": [5, 7], "gcam_class_4": [5, 7], "gcam_class_5": [5, 7], "osd": [5, 7], "serv": [5, 7], "place": [5, 7], "common": [5, 7], "scale": [5, 7], "ground": [5, 7], "represent": [5, 7], "observed_class_1": [5, 7], "observed_class_2": [5, 7], "observed_class_3": [5, 7], "observed_class_4": [5, 7], "observed_class_5": [5, 7], "soil": [5, 7], "qualiti": [5, 7], "applic": [5, 7], "dure": [5, 7], "constrain": [5, 7], "imped": [5, 7], "abil": [5, 7], "abl": [5, 7], "nutrient_avail": [5, 7], "soil_qual": [5, 7], "subject": [5, 7], "util": [5, 7], "grassland": [5, 7], "rather": [5, 7], "forest": [5, 7], "influenc": [5, 7], "result": [5, 7], "overtak": [5, 7], "simpli": [5, 7], "fulli": [5, 7], "invers": [5, 7], "opportunist": [5, 7], "grow": [5, 7], "readili": [5, 7], "low": [5, 7], "exert": [5, 7], "highli": [5, 7], "cropland": [5, 7], "These": [5, 7], "develop": [5, 7], "target_fid": [5, 7], "7": [5, 7], "allow": [5, 7], "hierarch": [5, 7], "root": [5, 7], "input_dir": [5, 7], "output_dir": [5, 7], "allocation_dir": [5, 7], "hold": [5, 7], "observed_dir": [5, 7], "constraints_dir": [5, 7], "projected_dir": [5, 7], "spatial_allocation_fil": [5, 7], "gcam_allocation_fil": [5, 7], "kernel_allocation_fil": [5, 7], "transition_order_fil": [5, 7], "treatment_order_fil": [5, 7], "constraints_fil": [5, 7], "observed_lu_data": [5, 7], "projected_lu_data": [5, 7], "diagnostics_output_dir": [5, 7], "diagnost": [5, 7], "kept": [5, 7], "log_output_dir": [5, 7], "run_desc": [5, 7], "observed_id_field": [5, 7], "last": [5, 7], "use_constraint": [5, 7], "ignor": [5, 7], "spatial_resolut": [5, 7], "errortol": [5, 7], "toler": [5, 7], "kilometr": [5, 7], "non": [5, 7], "accomplish": [5, 7], "interv": [5, 7], "increment": [5, 7], "proj_factor": [5, 7], "ideal": [5, 7], "remaind": [5, 7], "stochastic_expans": [5, 7], "stochast": [5, 7], "selection_threshold": [5, 7], "threshold": [5, 7], "abov": [5, 7], "receiv": [5, 7], "let": [5, 7], "likelihood": [5, 7], "radiu": [5, 7], "target_years_output": [5, 7], "otherwis": [5, 7], "semicolon": [5, 7], "2020": [5, 7], "save_tabular": [5, 7], "tabular": [5, 7], "tabular_unit": [5, 7], "save_transit": [5, 7], "save_netcdf_yr": [5, 7], "hierarchi": [5, 7]}, "objects": {"": [[0, 0, 0, "-", "demeter"]], "demeter": [[0, 1, 1, "", "FormatGcamDataFrame"], [0, 1, 1, "", "Model"], [1, 0, 0, "-", "change"], [0, 0, 0, "-", "config_reader"], [0, 0, 0, "-", "constraints"], [2, 0, 0, "-", "demeter_io"], [0, 5, 1, "", "format_gcam_data"], [0, 5, 1, "", "get_package_data"], [0, 0, 0, "-", "install_supplement"], [0, 0, 0, "-", "logger"], [0, 0, 0, "-", "model"], [0, 0, 0, "-", "ncdf_conversion"], [0, 0, 0, "-", "preprocess_data"], [0, 0, 0, "-", "process"], [0, 0, 0, "-", "reconcile"], [0, 5, 1, "", "run_model"], [0, 0, 0, "-", "staging"], [0, 0, 0, "-", "test_read"], [3, 0, 0, "-", "tests"], [4, 0, 0, "-", "weight"]], "demeter.FormatGcamDataFrame": [[0, 2, 1, "", "DEMETER_BASIN_NAME_FIELD"], [0, 2, 1, "", "DEMETER_LANDCLASS_FIELD"], [0, 2, 1, "", "DEMETER_METRIC_FIELD"], [0, 2, 1, "", "DEMETER_REGID_FIELD"], [0, 2, 1, "", "GCAM_LANDCLASS_DELIM"], [0, 2, 1, "", "GCAM_REGION_FIELD"], [0, 2, 1, "", "GCAM_UNIT_FIELD"], [0, 2, 1, "", "GCAM_YEAR_FIELD"], [0, 3, 1, "", "build_basin_dict"], [0, 3, 1, "", "build_regions_dict"], [0, 3, 1, "", "format_land_data"], [0, 4, 1, "", "gcam_landalloc_field"], [0, 4, 1, "", "gcam_nodes_field"]], "demeter.Model": [[0, 3, 1, "", "build_generator"], [0, 3, 1, "", "cleanup"], [0, 3, 1, "", "execute"], [0, 3, 1, "", "initialize"], [0, 3, 1, "", "process_step"]], "demeter.change": [[1, 0, 0, "-", "expansion"], [1, 0, 0, "-", "intensification"]], "demeter.change.expansion": [[1, 5, 1, "", "apply_expansion"]], "demeter.change.intensification": [[1, 5, 1, "", "apply_intensification"], [1, 5, 1, "", "diff_diagnostic"], [1, 5, 1, "", "reg_metric_iter"]], "demeter.config_reader": [[0, 1, 1, "", "ReadConfig"], [0, 6, 1, "", "ValidationException"]], "demeter.config_reader.ReadConfig": [[0, 2, 1, "", "DATETIME_FORMAT"], [0, 3, 1, "", "check_exist"], [0, 3, 1, "", "ck_agg"], [0, 3, 1, "", "ck_ts"], [0, 3, 1, "", "ck_type"], [0, 3, 1, "", "ck_yr"], [0, 3, 1, "", "create_dir"], [0, 3, 1, "", "get_constraints"], [0, 3, 1, "", "get_outdir"], [0, 3, 1, "", "set_target"], [0, 3, 1, "", "vaild_length"], [0, 3, 1, "", "valid_integer"], [0, 3, 1, "", "valid_limit"], [0, 3, 1, "", "valid_string"]], "demeter.constraints": [[0, 1, 1, "", "ApplyConstraints"], [0, 6, 1, "", "ValidationException"]], "demeter.constraints.ApplyConstraints": [[0, 3, 1, "", "apply_constraints_zero"], [0, 3, 1, "", "apply_gcam_constraints"], [0, 3, 1, "", "apply_spat_constraints"], [0, 3, 1, "", "build_gcam_landmatrix"], [0, 3, 1, "", "build_spat_landmatrix"], [0, 3, 1, "", "compile_constraints"], [0, 3, 1, "", "reg_metric_lcs_zip"]], "demeter.demeter_io": [[2, 0, 0, "-", "reader"], [2, 0, 0, "-", "writer"]], "demeter.demeter_io.reader": [[2, 6, 1, "", "ValidationException"], [2, 5, 1, "", "csv_to_array"], [2, 5, 1, "", "read_allocation_data"], [2, 5, 1, "", "read_base"], [2, 5, 1, "", "read_gcam_file"], [2, 5, 1, "", "read_gcam_land"], [2, 5, 1, "", "to_array"], [2, 5, 1, "", "to_dict"], [2, 5, 1, "", "to_list"]], "demeter.demeter_io.writer": [[2, 5, 1, "", "arr_to_ascii"], [2, 5, 1, "", "array_to_csv"], [2, 5, 1, "", "lc_timestep_csv"], [2, 5, 1, "", "max_ascii_rast"], [2, 5, 1, "", "save_array"], [2, 5, 1, "", "to_netcdf_lc"], [2, 5, 1, "", "to_netcdf_yr"], [2, 5, 1, "", "write_transitions"]], "demeter.install_supplement": [[0, 1, 1, "", "InstallSupplement"], [0, 5, 1, "", "get_package_data"]], "demeter.install_supplement.InstallSupplement": [[0, 2, 1, "", "DATA_VERSION_URLS"], [0, 3, 1, "", "fetch_zenodo"]], "demeter.logger": [[0, 1, 1, "", "Logger"]], "demeter.logger.Logger": [[0, 2, 1, "", "LOG_FORMAT_STRING"], [0, 3, 1, "", "close_logger"], [0, 3, 1, "", "console_handler"], [0, 3, 1, "", "file_handler"]], "demeter.model": [[0, 1, 1, "", "Model"], [0, 6, 1, "", "ValidationException"], [0, 5, 1, "", "run_model"]], "demeter.model.Model": [[0, 3, 1, "", "build_generator"], [0, 3, 1, "", "cleanup"], [0, 3, 1, "", "execute"], [0, 3, 1, "", "initialize"], [0, 3, 1, "", "process_step"]], "demeter.ncdf_conversion": [[0, 1, 1, "", "DemeterToNetcdf"]], "demeter.ncdf_conversion.DemeterToNetcdf": [[0, 2, 1, "", "COMPRESSION_PARAMETERS"], [0, 3, 1, "", "generate_regrid_coordinates"], [0, 3, 1, "", "generate_scaled_coordinates"], [0, 3, 1, "", "process_output"]], "demeter.preprocess_data": [[0, 1, 1, "", "FormatGcamDataFrame"], [0, 5, 1, "", "format_gcam_data"]], "demeter.preprocess_data.FormatGcamDataFrame": [[0, 2, 1, "", "DEMETER_BASIN_NAME_FIELD"], [0, 2, 1, "", "DEMETER_LANDCLASS_FIELD"], [0, 2, 1, "", "DEMETER_METRIC_FIELD"], [0, 2, 1, "", "DEMETER_REGID_FIELD"], [0, 2, 1, "", "GCAM_LANDCLASS_DELIM"], [0, 2, 1, "", "GCAM_REGION_FIELD"], [0, 2, 1, "", "GCAM_UNIT_FIELD"], [0, 2, 1, "", "GCAM_YEAR_FIELD"], [0, 3, 1, "", "build_basin_dict"], [0, 3, 1, "", "build_regions_dict"], [0, 3, 1, "", "format_land_data"], [0, 4, 1, "", "gcam_landalloc_field"], [0, 4, 1, "", "gcam_nodes_field"]], "demeter.process": [[0, 1, 1, "", "ProcessStep"]], "demeter.process.ProcessStep": [[0, 3, 1, "", "expansion_pass"], [0, 3, 1, "", "intense_pass"], [0, 3, 1, "", "outputs"], [0, 3, 1, "", "prep_step"], [0, 3, 1, "", "process"]], "demeter.reconcile": [[0, 5, 1, "", "reconcile"], [0, 5, 1, "", "reg_metric_zip"], [0, 5, 1, "", "yr_reg_metric_zip"]], "demeter.staging": [[0, 1, 1, "", "Stage"]], "demeter.staging.Stage": [[0, 3, 1, "", "harmony"], [0, 3, 1, "", "kernel_filter"], [0, 3, 1, "", "prep_base"], [0, 3, 1, "", "prep_projected"], [0, 3, 1, "", "prep_reference"], [0, 3, 1, "", "set_constraints"], [0, 3, 1, "", "set_step_zero"], [0, 3, 1, "", "stage"]], "demeter.tests": [[3, 0, 0, "-", "test_model_output"]], "demeter.tests.test_model_output": [[3, 1, 1, "", "TestOutputs"]], "demeter.tests.test_model_output.TestOutputs": [[3, 2, 1, "", "COMP_2010"], [3, 2, 1, "", "COMP_2015"], [3, 2, 1, "", "GCAMWRAPPER_DF"], [3, 2, 1, "", "RUN_DIR"], [3, 3, 1, "", "test_proj_outputs_using_args"]], "demeter.weight": [[4, 0, 0, "-", "kernel_density"]], "demeter.weight.kernel_density": [[4, 1, 1, "", "KernelDensity"], [4, 5, 1, "", "handle_single_pft"]], "demeter.weight.kernel_density.KernelDensity": [[4, 3, 1, "", "apply_convolution"], [4, 3, 1, "", "compute_cell_index"], [4, 3, 1, "", "convolution_filter"], [4, 3, 1, "", "dist_iter"], [4, 3, 1, "", "global_system"], [4, 3, 1, "", "prep_arrays"], [4, 3, 1, "", "preprocess_kernel_density"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:property", "5": "py:function", "6": "py:exception"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "property", "Python property"], "5": ["py", "function", "Python function"], "6": ["py", "exception", "Python exception"]}, "titleterms": {"demet": [0, 1, 2, 3, 4, 5, 6, 7], "packag": [0, 1, 2, 3, 4], "subpackag": 0, "submodul": [0, 1, 2, 3, 4], "config_read": 0, "modul": [0, 1, 2, 3, 4], "constraint": [0, 5, 7], "install_suppl": 0, "logger": 0, "model": [0, 5, 7], "ncdf_convers": 0, "preprocess_data": 0, "process": 0, "reconcil": 0, "stage": 0, "test_read": 0, "content": [0, 1, 2, 3, 4], "chang": [1, 5, 7], "expans": 1, "intensif": 1, "demeter_io": 2, "reader": 2, "writer": 2, "test": 3, "test_model_output": 3, "weight": [4, 5, 7], "kernel_dens": 4, "welcom": 5, "": 5, "document": 5, "indic": 5, "tabl": 5, "main": [], "readm": [], "A": [5, 7], "land": [5, 7], "us": [5, 7], "cover": [5, 7], "disaggreg": [5, 7], "detect": [5, 7], "get": [5, 7], "start": [5, 7], "setup": [5, 7], "observ": [5, 7], "spatial": [5, 7], "data": [5, 7], "project": [5, 7], "alloc": [5, 7], "file": [5, 7], "class": [5, 7], "kernel": [5, 7], "densiti": [5, 7], "transit": [5, 7], "prioriti": [5, 7], "treatment": [5, 7], "order": [5, 7], "requir": [5, 7], "configur": [5, 7]}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"demeter package": [[0, "demeter-package"]], "Subpackages": [[0, "subpackages"]], "Submodules": [[0, "submodules"], [1, "submodules"], [2, "submodules"], [3, "submodules"], [4, "submodules"]], "demeter.config_reader module": [[0, "module-demeter.config_reader"]], "demeter.constraints module": [[0, "module-demeter.constraints"]], "demeter.install_supplement module": [[0, "module-demeter.install_supplement"]], "demeter.logger module": [[0, "module-demeter.logger"]], "demeter.model module": [[0, "module-demeter.model"]], "demeter.ncdf_conversion module": [[0, "module-demeter.ncdf_conversion"]], "demeter.preprocess_data module": [[0, "module-demeter.preprocess_data"]], "demeter.process module": [[0, "module-demeter.process"]], "demeter.reconcile module": [[0, "module-demeter.reconcile"]], "demeter.staging module": [[0, "module-demeter.staging"]], "demeter.test_read module": [[0, "module-demeter.test_read"]], "Module contents": [[0, "module-demeter"], [1, "module-demeter.change"], [2, "module-demeter.demeter_io"], [3, "module-demeter.tests"], [4, "module-demeter.weight"]], "demeter.change package": [[1, "demeter-change-package"]], "demeter.change.expansion module": [[1, "module-demeter.change.expansion"]], "demeter.change.intensification module": [[1, "module-demeter.change.intensification"]], "demeter.demeter_io package": [[2, "demeter-demeter-io-package"]], "demeter.demeter_io.reader module": [[2, "module-demeter.demeter_io.reader"]], "demeter.demeter_io.writer module": [[2, "module-demeter.demeter_io.writer"]], "demeter.tests package": [[3, "demeter-tests-package"]], "demeter.tests.test_model_output module": [[3, "module-demeter.tests.test_model_output"]], "demeter.weight package": [[4, "demeter-weight-package"]], "demeter.weight.kernel_density module": [[4, "module-demeter.weight.kernel_density"]], "demeter": [[6, "demeter"]], "Welcome to Demeter\u2019s documentation!": [[5, "welcome-to-demeter-s-documentation"]], "Demeter": [[5, "demeter"], [7, "demeter"]], "A land-use and land-cover disaggregation and change detection model": [[5, "a-land-use-and-land-cover-disaggregation-and-change-detection-model"], [7, "a-land-use-and-land-cover-disaggregation-and-change-detection-model"]], "Getting Started with Demeter": [[5, "getting-started-with-demeter"], [7, "getting-started-with-demeter"]], "Setup": [[5, "id1"], [7, "id1"]], "Observed spatial data:": [[5, "observed-spatial-data"], [7, "observed-spatial-data"]], "Projected land allocation data:": [[5, "projected-land-allocation-data"], [7, "projected-land-allocation-data"]], "Allocation files:": [[5, "allocation-files"], [7, "allocation-files"]], "Projected land class allocation:": [[5, "projected-land-class-allocation"], [7, "projected-land-class-allocation"]], "Observational spatial data class allocation:": [[5, "observational-spatial-data-class-allocation"], [7, "observational-spatial-data-class-allocation"]], "Constraint weighting:": [[5, "constraint-weighting"], [7, "constraint-weighting"]], "Kernel density weighting:": [[5, "kernel-density-weighting"], [7, "kernel-density-weighting"]], "Transition Priority:": [[5, "transition-priority"], [7, "transition-priority"]], "Treatment order:": [[5, "treatment-order"], [7, "treatment-order"]], "Constraints (not required):": [[5, "constraints-not-required"], [7, "constraints-not-required"]], "Configuration file:": [[5, "configuration-file"], [7, "configuration-file"]], "Indices and tables": [[5, "indices-and-tables"]]}, "indexentries": {}})