3. ws3 Package and Data Preparation

• 3.1. About the ws3 Package
  • 3.1.1. Overview of Main Classes and Functions
  • 3.1.2. Common Use Case and Sample Notebooks
• 3.2. ws3 Package Modules
  • 3.2.1. common module
    • clean_vector_data()
    • harv_cost()
    • harv_cost_rv()
    • harv_cost_wec()
    • hash_dt()
    • hex_id()
    • is_num()
    • piece_size_ratio()
    • rasterize_stands()
    • reproject()
    • reproject_vector_data()
    • sylv_cred()
    • sylv_cred_formula()
    • sylv_cred_rv()
    • timed()
    • warp_raster()
  • 3.2.2. core module
    • Curve
      • Curve.add_points()
      • Curve.cai()
      • Curve.lookup()
      • Curve.mai()
      • Curve.points()
      • Curve.range()
      • Curve.simplify()
      • Curve.y()
      • Curve.ytp()
    • Interpolator
      • Interpolator.lookup()
      • Interpolator.points()
    • Node
      • Node.add_child()
      • Node.children()
      • Node.data()
      • Node.is_leaf()
      • Node.is_root()
      • Node.parent()
    • Tree
      • Tree.add_node()
      • Tree.children()
      • Tree.grow()
      • Tree.leaves()
      • Tree.node()
      • Tree.nodes()
      • Tree.path()
      • Tree.paths()
      • Tree.root()
      • Tree.ungrow()
  • 3.2.3. forest module
    • Action
    • DevelopmentType
      • DevelopmentType.add_ycomp()
      • DevelopmentType.area()
      • DevelopmentType.compile_action()
      • DevelopmentType.compile_actions()
      • DevelopmentType.grow()
      • DevelopmentType.initialize_areas()
      • DevelopmentType.is_operable()
      • DevelopmentType.operable_ages()
      • DevelopmentType.operable_area()
      • DevelopmentType.overwrite_initial_areas()
      • DevelopmentType.reset_areas()
      • DevelopmentType.resolve_condition()
      • DevelopmentType.ycomp()
      • DevelopmentType.ycomps()
    • ForestModel
      • ForestModel.add_null_action()
      • ForestModel.add_problem()
      • ForestModel.add_theme()
      • ForestModel.age_class_distribution()
      • ForestModel.apply_action()
      • ForestModel.apply_schedule()
      • ForestModel.commit_actions()
      • ForestModel.compile_actions()
      • ForestModel.compile_product()
      • ForestModel.compile_schedule()
      • ForestModel.create_dtype_fromkey()
      • ForestModel.dt()
      • ForestModel.grow()
      • ForestModel.import_actions_section()
      • ForestModel.import_areas_section()
      • ForestModel.import_constants_section()
      • ForestModel.import_control_section()
      • ForestModel.import_graphics_section()
      • ForestModel.import_landscape_section()
      • ForestModel.import_lifespan_section()
      • ForestModel.import_optimize_section()
      • ForestModel.import_outputs_section()
      • ForestModel.import_schedule_section()
      • ForestModel.import_transitions_section()
      • ForestModel.import_yields_section()
      • ForestModel.initialize_areas()
      • ForestModel.inventory()
      • ForestModel.is_harvest()
      • ForestModel.match_mask()
      • ForestModel.nthemes()
      • ForestModel.operable_area()
      • ForestModel.operable_dtypes()
      • ForestModel.operated_area()
      • ForestModel.overwrite_initial_areas()
      • ForestModel.piece_size()
      • ForestModel.register_curve()
      • ForestModel.repair_actions()
      • ForestModel.reset()
      • ForestModel.reset_actions()
      • ForestModel.reset_areas()
      • ForestModel.resolve_append()
      • ForestModel.resolve_condition()
      • ForestModel.resolve_replace()
      • ForestModel.resolve_tappend()
      • ForestModel.resolve_targetage()
      • ForestModel.resolve_tmask()
      • ForestModel.resolve_treplace()
      • ForestModel.set_horizon()
      • ForestModel.sylv_cred_formula()
      • ForestModel.theme_basecodes()
      • ForestModel.to_cbm_sit()
      • ForestModel.tree()
      • ForestModel.unmask()
    • GreedyAreaSelector
      • GreedyAreaSelector.operate()
    • Output
  • 3.2.4. forest_helper module
    • PersistentWorkerPool
    • auto_batch()
    • choose_max_batch_factor()
    • init_worker_gen_vars()
    • sanitize_func()
    • worker_cmp_cflw_batch()
    • worker_cmp_cflw_phase3()
    • worker_cmp_cflw_phase3_batch()
    • worker_cmp_cgen_batch()
    • worker_cmp_cgen_phase3()
    • worker_cmp_cgen_phase3_batch()
    • worker_gen_vars()
    • worker_summarize_tree_batch()
  • 3.2.5. financial module
    • harv_cost()
    • harv_cost_rv()
    • harv_cost_wec()
    • piece_size_ratio()
    • sylv_cred()
    • sylv_cred_formula()
    • sylv_cred_rv()
  • 3.2.6. opt module
    • Constraint
    • Problem
      • Problem.add_constraint()
      • Problem.add_var()
      • Problem.constraint_names()
      • Problem.get_all_constraints_lhs_values()
      • Problem.merge()
      • Problem.name()
      • Problem.sense()
      • Problem.solution()
      • Problem.solve()
      • Problem.solved()
      • Problem.solver()
      • Problem.status()
      • Problem.var()
      • Problem.var_names()
      • Problem.z()
    • Variable
  • 3.2.7. spatial module
    • ForestRaster
      • ForestRaster.allocate_schedule()
      • ForestRaster.cleanup()
      • ForestRaster.commit()
      • ForestRaster.grow()