fvs-python 0.2.3__py3-none-any.whl

pyfvs/cfg/sn_stand_density_index.json

@@ -0,0 +1,398 @@
+{
+  "metadata": {
+    "title": "Stand Density Index (SDI) for FVS Southern Variant",
+    "description": "Maximum stand density index values, calculation methods, and species-specific SDI maximums",
+    "source": "FVS Southern Variant Documentation - Section 3.5",
+    "equations": {
+      "3.5.1": "SDIMAXi = BAMAX / (0.5454154 * SDIU)"
+    },
+    "calculation_method": "Zeide calculation method (Dixon 2002)",
+    "variable_definitions": {
+      "SDIMAXi": "Species-specific SDI maximum",
+      "BAMAX": "User-specified stand basal area maximum",
+      "SDIU": "Proportion of theoretical maximum density at which the stand reaches actual maximum density (default 0.85, changed with the SDIMAX keyword)",
+      "SDI": "Stand density index",
+      "BA": "Basal area"
+    },
+    "methodology": {
+      "description": "Maximum stand density index (SDI) and maximum basal area (BA) are important variables in determining density related mortality and crown ratio change. Maximum basal area is a stand level metric that can be set using the BAMAX or SETSITE keywords. If not set by the user, a default value is calculated from maximum stand SDI each projection cycle. Maximum stand density index can be set for each species using the SDIMAX or SETSITE keywords. If not set by the user, a default value is assigned as discussed below.",
+      "default_sdi_assignment": "The default maximum SDI is set by species or a user specified basal area maximum. If a user specified basal area maximum is present, the maximum SDI for all species is computed using equation 3.5.1; otherwise, species SDI maximums are assigned from the SDI maximums shown in table 3.5.1.",
+      "stand_level_calculation": "Maximum stand density index at the stand level is a weighted average, by basal area, of the individual species SDI maximums.",
+      "calculation_method": "Stand SDI is calculated using the Zeide calculation method (Dixon 2002)."
+    }
+  },
+  "sdi_maximums": {
+    "FR": {
+      "sdi_maximum": 655,
+      "mapped_to": "balsam fir"
+    },
+    "JU": {
+      "sdi_maximum": 354,
+      "mapped_to": "eastern redcedar"
+    },
+    "PI": {
+      "sdi_maximum": 412,
+      "mapped_to": "white spruce"
+    },
+    "PU": {
+      "sdi_maximum": 499,
+      "mapped_to": "Virginia pine"
+    },
+    "SP": {
+      "sdi_maximum": 490,
+      "mapped_to": ""
+    },
+    "SA": {
+      "sdi_maximum": 385,
+      "mapped_to": ""
+    },
+    "SR": {
+      "sdi_maximum": 490,
+      "mapped_to": "shortleaf pine"
+    },
+    "LL": {
+      "sdi_maximum": 332,
+      "mapped_to": ""
+    },
+    "TM": {
+      "sdi_maximum": 398,
+      "mapped_to": "pitch pine"
+    },
+    "PP": {
+      "sdi_maximum": 398,
+      "mapped_to": ""
+    },
+    "PD": {
+      "sdi_maximum": 310,
+      "mapped_to": ""
+    },
+    "WP": {
+      "sdi_maximum": 529,
+      "mapped_to": ""
+    },
+    "LP": {
+      "sdi_maximum": 480,
+      "mapped_to": ""
+    },
+    "VP": {
+      "sdi_maximum": 499,
+      "mapped_to": ""
+    },
+    "BY": {
+      "sdi_maximum": 692,
+      "mapped_to": ""
+    },
+    "PC": {
+      "sdi_maximum": 623,
+      "mapped_to": ""
+    },
+    "HM": {
+      "sdi_maximum": 518,
+      "mapped_to": "eastern hemlock"
+    },
+    "FM": {
+      "sdi_maximum": 371,
+      "mapped_to": "sugar maple"
+    },
+    "BE": {
+      "sdi_maximum": 344,
+      "mapped_to": ""
+    },
+    "RM": {
+      "sdi_maximum": 421,
+      "mapped_to": ""
+    },
+    "SV": {
+      "sdi_maximum": 590,
+      "mapped_to": ""
+    },
+    "SM": {
+      "sdi_maximum": 371,
+      "mapped_to": ""
+    },
+    "BU": {
+      "sdi_maximum": 371,
+      "mapped_to": "sugar maple"
+    },
+    "BB": {
+      "sdi_maximum": 400,
+      "mapped_to": "river birch"
+    },
+    "SB": {
+      "sdi_maximum": 350,
+      "mapped_to": ""
+    },
+    "AH": {
+      "sdi_maximum": 375,
+      "mapped_to": ""
+    },
+    "HI": {
+      "sdi_maximum": 276,
+      "mapped_to": "pignut hickory"
+    },
+    "CA": {
+      "sdi_maximum": 492,
+      "mapped_to": "sassafras"
+    },
+    "HB": {
+      "sdi_maximum": 420,
+      "mapped_to": "hackberry"
+    },
+    "RD": {
+      "sdi_maximum": 422,
+      "mapped_to": ""
+    },
+    "DW": {
+      "sdi_maximum": 257,
+      "mapped_to": ""
+    },
+    "PS": {
+      "sdi_maximum": 147,
+      "mapped_to": ""
+    },
+    "AB": {
+      "sdi_maximum": 364,
+      "mapped_to": ""
+    },
+    "AS": {
+      "sdi_maximum": 414,
+      "mapped_to": "green ash"
+    },
+    "WA": {
+      "sdi_maximum": 408,
+      "mapped_to": ""
+    },
+    "BA": {
+      "sdi_maximum": 423,
+      "mapped_to": ""
+    },
+    "GA": {
+      "sdi_maximum": 414,
+      "mapped_to": ""
+    },
+    "HL": {
+      "sdi_maximum": 338,
+      "mapped_to": ""
+    },
+    "LB": {
+      "sdi_maximum": 492,
+      "mapped_to": "sweetbay"
+    },
+    "HA": {
+      "sdi_maximum": 430,
+      "mapped_to": "blackgum"
+    },
+    "HY": {
+      "sdi_maximum": 155,
+      "mapped_to": ""
+    },
+    "BN": {
+      "sdi_maximum": 283,
+      "mapped_to": "black walnut"
+    },
+    "WN": {
+      "sdi_maximum": 283,
+      "mapped_to": ""
+    },
+    "SU": {
+      "sdi_maximum": 430,
+      "mapped_to": ""
+    },
+    "YP": {
+      "sdi_maximum": 478,
+      "mapped_to": ""
+    },
+    "MG": {
+      "sdi_maximum": 492,
+      "mapped_to": "sweetbay"
+    },
+    "CT": {
+      "sdi_maximum": 415,
+      "mapped_to": ""
+    },
+    "MS": {
+      "sdi_maximum": 492,
+      "mapped_to": "sweetbay"
+    },
+    "MV": {
+      "sdi_maximum": 492,
+      "mapped_to": ""
+    },
+    "ML": {
+      "sdi_maximum": 492,
+      "mapped_to": "sweetbay"
+    },
+    "AP": {
+      "sdi_maximum": 422,
+      "mapped_to": "eastern redbud"
+    },
+    "MB": {
+      "sdi_maximum": 277,
+      "mapped_to": "red mulberry"
+    },
+    "WT": {
+      "sdi_maximum": 726,
+      "mapped_to": ""
+    },
+    "BG": {
+      "sdi_maximum": 430,
+      "mapped_to": ""
+    },
+    "TS": {
+      "sdi_maximum": 704,
+      "mapped_to": ""
+    },
+    "HH": {
+      "sdi_maximum": 304,
+      "mapped_to": ""
+    },
+    "SD": {
+      "sdi_maximum": 164,
+      "mapped_to": ""
+    },
+    "RA": {
+      "sdi_maximum": 492,
+      "mapped_to": "sweetbay"
+    },
+    "SY": {
+      "sdi_maximum": 499,
+      "mapped_to": ""
+    },
+    "CW": {
+      "sdi_maximum": 648,
+      "mapped_to": "eastern cottonwood"
+    },
+    "BT": {
+      "sdi_maximum": 520,
+      "mapped_to": ""
+    },
+    "BC": {
+      "sdi_maximum": 384,
+      "mapped_to": ""
+    },
+    "WO": {
+      "sdi_maximum": 361,
+      "mapped_to": ""
+    },
+    "SO": {
+      "sdi_maximum": 315,
+      "mapped_to": ""
+    },
+    "SK": {
+      "sdi_maximum": 342,
+      "mapped_to": ""
+    },
+    "CB": {
+      "sdi_maximum": 405,
+      "mapped_to": ""
+    },
+    "TO": {
+      "sdi_maximum": 326,
+      "mapped_to": "blackjack oak"
+    },
+    "LK": {
+      "sdi_maximum": 387,
+      "mapped_to": ""
+    },
+    "OV": {
+      "sdi_maximum": 384,
+      "mapped_to": ""
+    },
+    "BJ": {
+      "sdi_maximum": 326,
+      "mapped_to": ""
+    },
+    "SN": {
+      "sdi_maximum": 417,
+      "mapped_to": "chestnut oak"
+    },
+    "CK": {
+      "sdi_maximum": 336,
+      "mapped_to": ""
+    },
+    "WK": {
+      "sdi_maximum": 365,
+      "mapped_to": ""
+    },
+    "CO": {
+      "sdi_maximum": 417,
+      "mapped_to": ""
+    },
+    "RO": {
+      "sdi_maximum": 414,
+      "mapped_to": ""
+    },
+    "QS": {
+      "sdi_maximum": 342,
+      "mapped_to": "southern red oak"
+    },
+    "PO": {
+      "sdi_maximum": 311,
+      "mapped_to": ""
+    },
+    "BO": {
+      "sdi_maximum": 370,
+      "mapped_to": ""
+    },
+    "LO": {
+      "sdi_maximum": 410,
+      "mapped_to": ""
+    },
+    "BK": {
+      "sdi_maximum": 343,
+      "mapped_to": ""
+    },
+    "WI": {
+      "sdi_maximum": 447,
+      "mapped_to": "black willow"
+    },
+    "SS": {
+      "sdi_maximum": 492,
+      "mapped_to": ""
+    },
+    "BD": {
+      "sdi_maximum": 526,
+      "mapped_to": "American basswood"
+    },
+    "EL": {
+      "sdi_maximum": 282,
+      "mapped_to": "American elm"
+    },
+    "WE": {
+      "sdi_maximum": 263,
+      "mapped_to": ""
+    },
+    "AE": {
+      "sdi_maximum": 282,
+      "mapped_to": ""
+    },
+    "RL": {
+      "sdi_maximum": 227,
+      "mapped_to": ""
+    },
+    "OS": {
+      "sdi_maximum": 354,
+      "mapped_to": "eastern redcedar"
+    },
+    "OH": {
+      "sdi_maximum": 492,
+      "mapped_to": "sassafras"
+    },
+    "OT": {
+      "sdi_maximum": 421,
+      "mapped_to": "red maple"
+    }
+  },
+  "data_source": {
+    "note": "Source of SDI maximums is an unpublished analysis of FIA data by John Shaw."
+  },
+  "keywords": {
+    "BAMAX": "Set maximum basal area",
+    "SETSITE": "Set site characteristics including maximum basal area and SDI",
+    "SDIMAX": "Set maximum stand density index by species"
+  },
+  "default_parameters": {
+    "sdiu_default": 0.85,
+    "zeide_constant": 0.5454154
+  }
+} 

pyfvs/cfg/species/ab_american_basswood.yaml

@@ -0,0 +1,251 @@
+metadata:
+  code: AB
+  fia_code: 951
+  scientific_name: Tilia americana
+  common_name: american basswood
+  valid_site_species: true
+site_index:
+  min: 35
+  max: 85
+  site_index_group: 3
+  height_growth_equation: 'NC-128: 531/26'
+density:
+  sdi_max: 364
+height_diameter:
+  model: curtis_arney
+  curtis_arney:
+    p2: 526.1392688
+    p3: 3.89232121
+    p4: -0.22587084
+    dbw: 0.1
+  wykoff:
+    b1: 4.4772
+    b2: -4.7206
+bark_ratio:
+  b1: -0.1304
+  b2: 0.97071
+crown_ratio:
+  acr_equation: 4.3.1.6
+  d0: 59.09
+  d1: -4.99
+  d2: null
+  a: 4.6965
+  b0: -14.3809
+  b1: 1.2016
+  c: 3.5571
+diameter_growth:
+  model: ln_dds
+  coefficients:
+    b1: -1.251887
+    b2: 1.349337
+    b3: -0.000447
+    b4: 0.193148
+    b5: 0.279322
+    b6: -0.000287
+    b7: -0.002547
+    b8: -0.001176
+    b9: -0.3804
+    b10: 0.160386
+    b11: -0.088382
+  dbh_bounds:
+    lower_limit: 42.8
+    upper_limit: 60.0
+volume:
+  pulpwood:
+    min_dbh: 6
+    top_diameter: 4
+  sawtimber:
+    min_dbh: 10
+    top_diameter: 7
+crown_width:
+  forest_grown:
+    equation_number: '53101'
+    a1: 3.9361
+    a2: 1.15
+    a3: null
+    a4: 0.1237
+    a5: -0.0691
+    bounds: FCW < 80
+  open_grown:
+    equation_number: '53101'
+    a1: 3.9361
+    a2: 1.15
+    a3: null
+    a4: 0.1237
+    a5: -0.0691
+    bounds: OCW < 80
+small_tree_height_growth:
+  model: chapman_richards_nc128
+  threshold_diameter: 3.0
+  fia_code: '531'
+  page_number: '26'
+  c1: 29.73
+  c2: 0.3631
+  c3: -0.0127
+  c4: 16.7616
+  c5: -0.6804
+large_tree_height_growth:
+  model: wensel_1987
+  threshold_diameter: 3.0
+  methodology:
+    approach: Wensel and others (1987)
+    crown_ratio_weight: 0.25
+    relative_height_weight: 0.75
+  equations:
+    main: HTG = POTHTG * (0.25 * HGMDCR + 0.75 * HGMDRH)
+    crown_ratio_modifier: HGMDCR = 100 * CR^3.0 * exp(-5.0*CR)
+    relative_height_modifier: HGMDRH = RHK * (1 + FCTRKX * exp(FCTRRB*FCTRXB))^FCTRM
+  shade_tolerance: Very Tolerant
+  shade_tolerance_coefficients:
+    RHR: 20
+    RHYXS: 0.2
+    RHM: 1.1
+    RHB: -1.1
+    RHXS: 0
+    RHK: 1
+fortype:
+  base_fortype: FTUPOK
+  coefficients:
+    FTLOHD: 0.139891
+    FTNOHD: 0.094979
+    FTOKPN: 0.112394
+    FTSFHP: 0.191476
+    FTUPHD: 0.098473
+    FTUPOK: 0.0
+    FTYLPN: 0.301892
+  forest_type_groups:
+    FTLOHD:
+      name: Lowland Hardwoods
+      fia_forest_types:
+      - 168
+      - 508
+      - 601
+      - 602
+      - 605
+      - 606
+      - 607
+      - 608
+      - 702
+      - 703
+      - 704
+      - 705
+      - 706
+      - 708
+    FTNOHD:
+      name: Northern Hardwoods
+      fia_forest_types:
+      - 701
+      - 801
+      - 805
+    FTOKPN:
+      name: Oak - Pine
+      fia_forest_types:
+      - 165
+      - 403
+      - 404
+      - 405
+      - 406
+      - 407
+      - 409
+    FTSFHP:
+      name: Spruce - Fir - Hemlock - Pine
+      fia_forest_types:
+      - 104
+      - 105
+      - 121
+      - 124
+    FTUPHD:
+      name: Upland Hardwoods
+      fia_forest_types:
+      - 103
+      - 167
+      - 181
+      - 401
+      - 402
+      - 506
+      - 511
+      - 512
+      - 513
+      - 519
+      - 520
+      - 802
+      - 807
+      - 809
+    FTUPOK:
+      name: Upland Oak
+      fia_forest_types:
+      - 501
+      - 502
+      - 503
+      - 504
+      - 505
+      - 510
+      - 514
+      - 515
+    FTYLPN:
+      name: Yellow Pine
+      fia_forest_types:
+      - 141
+      - 142
+      - 161
+      - 162
+      - 163
+      - 164
+      - 166
+ecounit:
+  table_4_7_1_5:
+    base_ecounit: '232'
+    coefficients:
+      M221: -0.191377
+      M222: -0.370162
+      M231: -0.181571
+      '221': -0.105676
+      '222': 0.093229
+      231T: 0.006941
+    ecological_unit_groups:
+      M221: Ecological unit group M221
+      M222: Ecological unit group M222
+      M231: Ecological unit group M231
+      '221': Ecological unit group 221
+      '222': Ecological unit group 222
+      231T: Ecological unit group 231T
+      231L: Ecological unit group 231L
+      '232': Ecological unit group 232
+      '234': Ecological unit group 234
+      '255': Ecological unit group 255
+      '411': Ecological unit group 411
+  table_4_7_1_6:
+    base_ecounit: '232'
+    coefficients:
+      231L: -0.003611
+      '232': 0.0
+      '234': -0.031277
+      '255': 0.0
+      '411': 0.0
+    ecological_unit_groups:
+      231L: Ecological unit group 231L
+      '232': Ecological unit group 232
+      '234': Ecological unit group 234
+      '255': Ecological unit group 255
+      '411': Ecological unit group 411
+mortality:
+  background_mortality:
+    equation: 5.0.1
+    formula: RI = [1 / (1 + exp(p0 + p1 * DBH))]
+    coefficients:
+      p0: 5.1676998
+      p1: -0.0077681
+  mortality_weight:
+    mwt: 0.1
+    description: Species-specific mortality weight value representing shade tolerance
+regeneration:
+  parameters:
+    sprouting_capable: true
+    min_bud_width: 0.1
+    min_height: 0.5
+    max_height: 20
+  sprouting:
+    probability: 0.93
+    equation: fixed
+    sprout_records: 6.0.1
+    source: Keyser and Loftis, 2014