PyPI - fvs-python - Versions diffs - 0.2.3__py3-none-any.whl - Mend

fvs-python 0.2.3__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (149) hide show

fvs_python-0.2.3.dist-info/METADATA +254 -0
fvs_python-0.2.3.dist-info/RECORD +149 -0
fvs_python-0.2.3.dist-info/WHEEL +5 -0
fvs_python-0.2.3.dist-info/licenses/LICENSE +21 -0
fvs_python-0.2.3.dist-info/top_level.txt +1 -0
pyfvs/__init__.py +107 -0
pyfvs/bark_ratio.py +323 -0
pyfvs/cfg/CFG_README.md +73 -0
pyfvs/cfg/dbh_bounding_table_4_7_1_8.json +103 -0
pyfvs/cfg/ecounit_coefficients_table_4_7_1_5.json +981 -0
pyfvs/cfg/ecounit_coefficients_table_4_7_1_6.json +856 -0
pyfvs/cfg/forest_type_mapping_table_4_7_1_4.json +38 -0
pyfvs/cfg/fortype_coefficients_table_4_7_1_3.json +1183 -0
pyfvs/cfg/functional_forms.yaml +111 -0
pyfvs/cfg/growth_model_parameters.yaml +98 -0
pyfvs/cfg/plant_values_table_4_7_1_7.json +15 -0
pyfvs/cfg/site_index_transformation.yaml +113 -0
pyfvs/cfg/sn_bark_ratio_coefficients.json +115 -0
pyfvs/cfg/sn_crown_competition_factor.json +109 -0
pyfvs/cfg/sn_crown_ratio_coefficients.json +956 -0
pyfvs/cfg/sn_crown_width_coefficients.json +1664 -0
pyfvs/cfg/sn_diameter_growth_coefficients.json +300 -0
pyfvs/cfg/sn_height_diameter_coefficients.json +97 -0
pyfvs/cfg/sn_large_tree_diameter_growth.json +191 -0
pyfvs/cfg/sn_large_tree_height_growth.json +229 -0
pyfvs/cfg/sn_large_tree_height_growth_coefficients.json +1187 -0
pyfvs/cfg/sn_mortality_model.json +176 -0
pyfvs/cfg/sn_regeneration_model.json +252 -0
pyfvs/cfg/sn_relative_site_index.json +263 -0
pyfvs/cfg/sn_small_tree_height_growth.json +879 -0
pyfvs/cfg/sn_species_codes_table.json +728 -0
pyfvs/cfg/sn_stand_density_index.json +398 -0
pyfvs/cfg/species/ab_american_basswood.yaml +251 -0
pyfvs/cfg/species/ae_american_elm.yaml +240 -0
pyfvs/cfg/species/ah_american_hornbeam.yaml +250 -0
pyfvs/cfg/species/ap_american_plum.yaml +251 -0
pyfvs/cfg/species/as_american_sycamore.yaml +253 -0
pyfvs/cfg/species/ba_black_ash.yaml +254 -0
pyfvs/cfg/species/bb_basswood.yaml +254 -0
pyfvs/cfg/species/bc_black_cherry.yaml +254 -0
pyfvs/cfg/species/bd_sweet_birch.yaml +252 -0
pyfvs/cfg/species/be_american_beech.yaml +251 -0
pyfvs/cfg/species/bg_black_gum.yaml +252 -0
pyfvs/cfg/species/bj_blue_jay.yaml +254 -0
pyfvs/cfg/species/bk_sugar_maple.yaml +251 -0
pyfvs/cfg/species/bn_butternut.yaml +252 -0
pyfvs/cfg/species/bo_red_maple.yaml +255 -0
pyfvs/cfg/species/bt_bigtooth_aspen.yaml +254 -0
pyfvs/cfg/species/bu_buckeye.yaml +252 -0
pyfvs/cfg/species/by_bald_cypress.yaml +255 -0
pyfvs/cfg/species/ca_american_chestnut.yaml +254 -0
pyfvs/cfg/species/cb_cucumber_tree.yaml +254 -0
pyfvs/cfg/species/ck_virginia_pine.yaml +254 -0
pyfvs/cfg/species/co_pond_cypress.yaml +251 -0
pyfvs/cfg/species/ct_catalpa.yaml +251 -0
pyfvs/cfg/species/cw_chestnut_oak.yaml +253 -0
pyfvs/cfg/species/dw_dogwood.yaml +250 -0
pyfvs/cfg/species/el_american_hornbeam.yaml +254 -0
pyfvs/cfg/species/fm_flowering_dogwood.yaml +251 -0
pyfvs/cfg/species/fr_fraser_fir.yaml +247 -0
pyfvs/cfg/species/ga_green_ash.yaml +254 -0
pyfvs/cfg/species/ha_hawthorn.yaml +252 -0
pyfvs/cfg/species/hb_hornbeam.yaml +254 -0
pyfvs/cfg/species/hh_dogwood.yaml +251 -0
pyfvs/cfg/species/hi_hickory_species.yaml +252 -0
pyfvs/cfg/species/hl_holly.yaml +254 -0
pyfvs/cfg/species/hm_eastern_hemlock.yaml +246 -0
pyfvs/cfg/species/hy_holly.yaml +252 -0
pyfvs/cfg/species/ju_eastern_juniper.yaml +247 -0
pyfvs/cfg/species/lb_loblolly_bay.yaml +254 -0
pyfvs/cfg/species/lk_laurel_oak.yaml +254 -0
pyfvs/cfg/species/ll_longleaf_pine.yaml +265 -0
pyfvs/cfg/species/lo_silver_maple.yaml +252 -0
pyfvs/cfg/species/lp_loblolly_pine.yaml +268 -0
pyfvs/cfg/species/mb_mountain_birch.yaml +250 -0
pyfvs/cfg/species/mg_magnolia.yaml +251 -0
pyfvs/cfg/species/ml_maple_leaf.yaml +254 -0
pyfvs/cfg/species/ms_maple_species.yaml +247 -0
pyfvs/cfg/species/mv_magnolia_vine.yaml +254 -0
pyfvs/cfg/species/oh_other_hardwood.yaml +231 -0
pyfvs/cfg/species/os_other_softwood.yaml +232 -0
pyfvs/cfg/species/ot_other_tree.yaml +210 -0
pyfvs/cfg/species/ov_overcup_oak.yaml +254 -0
pyfvs/cfg/species/pc_pond_cypress.yaml +254 -0
pyfvs/cfg/species/pd_pitch_pine.yaml +245 -0
pyfvs/cfg/species/pi_pine_species.yaml +246 -0
pyfvs/cfg/species/po_american_beech.yaml +254 -0
pyfvs/cfg/species/pp_pond_pine.yaml +246 -0
pyfvs/cfg/species/ps_persimmon.yaml +251 -0
pyfvs/cfg/species/pu_pond_pine.yaml +249 -0
pyfvs/cfg/species/qs_flowering_dogwood.yaml +254 -0
pyfvs/cfg/species/ra_red_ash.yaml +245 -0
pyfvs/cfg/species/rd_redbud.yaml +251 -0
pyfvs/cfg/species/rl_red_elm.yaml +240 -0
pyfvs/cfg/species/rm_red_maple.yaml +256 -0
pyfvs/cfg/species/ro_eastern_hemlock.yaml +255 -0
pyfvs/cfg/species/sa_slash_pine.yaml +265 -0
pyfvs/cfg/species/sb_sweet_birch.yaml +255 -0
pyfvs/cfg/species/sd_sand_pine.yaml +251 -0
pyfvs/cfg/species/sk_swamp_oak.yaml +253 -0
pyfvs/cfg/species/sm_sugar_maple.yaml +252 -0
pyfvs/cfg/species/sn_loblolly_pine.yaml +254 -0
pyfvs/cfg/species/so_southern_oak.yaml +253 -0
pyfvs/cfg/species/sp_shortleaf_pine.yaml +267 -0
pyfvs/cfg/species/sr_spruce_pine.yaml +246 -0
pyfvs/cfg/species/ss_basswood.yaml +251 -0
pyfvs/cfg/species/su_sweetgum.yaml +255 -0
pyfvs/cfg/species/sv_silver_maple.yaml +255 -0
pyfvs/cfg/species/sy_sycamore.yaml +254 -0
pyfvs/cfg/species/tm_tamarack.yaml +246 -0
pyfvs/cfg/species/to_tulip_oak.yaml +254 -0
pyfvs/cfg/species/ts_tulip_tree.yaml +253 -0
pyfvs/cfg/species/vp_virginia_pine.yaml +248 -0
pyfvs/cfg/species/wa_white_ash.yaml +254 -0
pyfvs/cfg/species/we_white_elm.yaml +250 -0
pyfvs/cfg/species/wi_willow.yaml +248 -0
pyfvs/cfg/species/wk_water_oak.yaml +254 -0
pyfvs/cfg/species/wn_walnut.yaml +254 -0
pyfvs/cfg/species/wo_white_oak.yaml +256 -0
pyfvs/cfg/species/wp_white_pine.yaml +250 -0
pyfvs/cfg/species/wt_water_tupelo.yaml +254 -0
pyfvs/cfg/species/yp_yellow_poplar.yaml +261 -0
pyfvs/cfg/species_config.yaml +106 -0
pyfvs/clark_profile.py +323 -0
pyfvs/competition.py +332 -0
pyfvs/config_loader.py +375 -0
pyfvs/crown_competition_factor.py +464 -0
pyfvs/crown_ratio.py +377 -0
pyfvs/crown_width.py +512 -0
pyfvs/data_export.py +356 -0
pyfvs/ecological_unit.py +272 -0
pyfvs/exceptions.py +86 -0
pyfvs/fia_integration.py +876 -0
pyfvs/forest_type.py +253 -0
pyfvs/growth_plots.py +579 -0
pyfvs/harvest.py +603 -0
pyfvs/height_diameter.py +248 -0
pyfvs/large_tree_height_growth.py +822 -0
pyfvs/logging_config.py +213 -0
pyfvs/main.py +99 -0
pyfvs/mortality.py +431 -0
pyfvs/parameters.py +121 -0
pyfvs/simulation_engine.py +386 -0
pyfvs/stand.py +1004 -0
pyfvs/stand_metrics.py +436 -0
pyfvs/stand_output.py +552 -0
pyfvs/tree.py +756 -0
pyfvs/validation.py +190 -0
pyfvs/volume_library.py +761 -0

pyfvs/cfg/species/bg_black_gum.yaml ADDED Viewed

@@ -0,0 +1,252 @@
+metadata:
+  code: BG
+  fia_code: 693
+  scientific_name: Nyssa sylvatica
+  common_name: black gum
+  valid_site_species: false
+site_index:
+  min: 35
+  max: 105
+  site_index_group: 3
+  height_growth_equation: 'NC-128: 694/42'
+density:
+  sdi_max: 430
+height_diameter:
+  model: curtis_arney
+  curtis_arney:
+    p2: 319.9788466
+    p3: 3.67313408
+    p4: -0.30651323
+    dbw: 0.2
+  wykoff:
+    b1: 4.3802
+    b2: -4.7903
+bark_ratio:
+  b1: 0.19899
+  b2: 0.88941
+crown_ratio:
+  acr_equation: 4.3.1.5
+  d0: 41.01
+  d1: null
+  d2: -0.21
+  a: 5.0
+  b0: -15.1643
+  b1: 1.9983
+  c: 3.0081
+diameter_growth:
+  model: ln_dds
+  coefficients:
+    b1: -1.508549
+    b2: 1.306362
+    b3: -0.000576
+    b4: 0.112403
+    b5: 0.121169
+    b6: 0.003356
+    b7: -0.002482
+    b8: -0.001013
+    b9: -0.296628
+    b10: -0.131968
+    b11: -0.031596
+  dbh_bounds:
+    lower_limit: null
+    upper_limit: null
+    note: No diameter bounds applied
+volume:
+  pulpwood:
+    min_dbh: 6
+    top_diameter: 4
+  sawtimber:
+    min_dbh: 10
+    top_diameter: 7
+crown_width:
+  forest_grown:
+    equation_number: '69301'
+    a1: 5.5037
+    a2: 1.0567
+    a3: null
+    a4: 0.088
+    a5: 0.061
+    bounds: FCW < 50
+  open_grown:
+    equation_number: '69301'
+    a1: 5.5037
+    a2: 1.0567
+    a3: null
+    a4: 0.088
+    a5: 0.061
+    bounds: OCW < 50
+small_tree_height_growth:
+  model: chapman_richards_nc128
+  threshold_diameter: 3.0
+  fia_code: '694'
+  page_number: '42'
+  c1: 1.3213
+  c2: 0.9995
+  c3: -0.0254
+  c4: 0.8549
+  c5: -0.0016
+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: Tolerant
+  shade_tolerance_coefficients:
+    RHR: 16
+    RHYXS: 0.15
+    RHM: 1.1
+    RHB: -1.2
+    RHXS: 0
+    RHK: 1
+fortype:
+  base_fortype: FTUPOK
+  coefficients:
+    FTLOHD: 0.114656
+    FTNOHD: 0.063092
+    FTOKPN: 0.076702
+    FTSFHP: -0.447981
+    FTUPHD: 0.111483
+    FTUPOK: 0.0
+    FTYLPN: 0.22918
+  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.014903
+      M222: -0.266804
+      M231: -0.251634
+      '221': -0.000477
+      '222': 0.058798
+      231T: -0.116789
+    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.138867
+      '232': 0.0
+      '234': -0.031436
+      '255': 0.37582
+      '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.3
+    description: Species-specific mortality weight value representing shade tolerance
+regeneration:
+  parameters:
+    sprouting_capable: true
+    min_bud_width: 0.2
+    min_height: 3.59
+    max_height: 20
+  sprouting:
+    probability: 0.72
+    equation: fixed
+    sprout_records: 1
+    source: Keyser and Loftis, 2014

pyfvs/cfg/species/bj_blue_jay.yaml ADDED Viewed

@@ -0,0 +1,254 @@
+metadata:
+  code: BJ
+  fia_code: 999
+  scientific_name: Cyanocitta cristata
+  common_name: blue jay
+  valid_site_species: false
+site_index:
+  min: 25
+  max: 65
+  site_index_group: 3
+  height_growth_equation: 'NC-128: 068/73'
+density:
+  sdi_max: 326
+height_diameter:
+  model: curtis_arney
+  curtis_arney:
+    p2: 157.4828626
+    p3: 3.38919504
+    p4: -0.39151499
+    dbw: 0.2
+  wykoff:
+    b1: 3.9191
+    b2: -4.3503
+bark_ratio:
+  b1: -0.61021
+  b2: 0.95803
+crown_ratio:
+  acr_equation: 4.3.1.6
+  d0: 56.42
+  d1: -14.13
+  d2: null
+  a: 4.1406
+  b0: 13.695
+  b1: 0.6895
+  c: 3.0427
+diameter_growth:
+  model: ln_dds
+  coefficients:
+    b1: -1.948938
+    b2: 1.611438
+    b3: -0.000844
+    b4: 0.135696
+    b5: 0.056739
+    b6: 0.00274
+    b7: -0.003558
+    b8: -0.001825
+    b9: -0.071837
+    b10: -0.147407
+    b11: 0.241882
+  dbh_bounds:
+    lower_limit: 22.7
+    upper_limit: 27.0
+volume:
+  pulpwood:
+    min_dbh: 6
+    top_diameter: 4
+  sawtimber:
+    min_dbh: 10
+    top_diameter: 7
+crown_width:
+  forest_grown:
+    equation_number: '82401'
+    a1: 0.5443
+    a2: 1.4882
+    a3: null
+    a4: 0.0565
+    a5: null
+    bounds: FCW < 37
+  open_grown:
+    equation_number: '82401'
+    a1: 0.5443
+    a2: 1.4882
+    a3: null
+    a4: 0.0565
+    a5: null
+    bounds: OCW < 37
+small_tree_height_growth:
+  model: chapman_richards_nc128
+  threshold_diameter: 3.0
+  fia_code: 068
+  page_number: '73'
+  c1: 0.9276
+  c2: 1.0591
+  c3: -0.0424
+  c4: 0.3529
+  c5: 0.3114
+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: Intolerant
+  shade_tolerance_coefficients:
+    RHR: 13
+    RHYXS: 0.05
+    RHM: 1.1
+    RHB: -1.6
+    RHXS: 0
+    RHK: 1
+fortype:
+  base_fortype: FTUPOK
+  coefficients:
+    FTLOHD: -0.123167
+    FTNOHD: 0.0
+    FTOKPN: 0.000279
+    FTSFHP: 0.0
+    FTUPHD: 0.170335
+    FTUPOK: 0.0
+    FTYLPN: -0.096186
+  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.172582
+      M222: 0.107373
+      M231: -0.084775
+      '221': 0.127193
+      '222': -0.066699
+      231T: -0.052485
+    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.178459
+      '232': 0.0
+      '234': -0.037201
+      '255': 0.380348
+      '411': -0.741911
+    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.9617
+      p1: -0.0340128
+  mortality_weight:
+    mwt: 0.7
+    description: Species-specific mortality weight value representing shade tolerance
+regeneration:
+  parameters:
+    sprouting_capable: true
+    min_bud_width: 0.2
+    min_height: 2.75
+    max_height: 20
+  sprouting:
+    probability: equation_6.0.3
+    equation: 6.0.3
+    sprout_records: 1
+    source: Keyser and Loftis, 2014
+    coefficients:
+      b0: 2.7386
+      b1: -0.1076