API reference
The API reference is generated from the docstrings and annotations in src/fresh_fvsbc/ and
scripts/. Every public function is listed with its signature, its parameter types, and its
return value. Search this reference before you call one of these functions. Add a page here, with
an automodule entry, whenever you add a module to the project.
The package is the library a caller imports. The scripts are the project’s own tooling: they run the gates and validate the planning surfaces, and they are not part of the installed package.
fresh_fvsbcT1, and why the layout is not the declared oneBC_TREFMTDONOR_SPECIESFIA_CODESFIELD_DESCRIPTORSFIELD_NAMESJSP_CODESPLANTS_SYMBOLSREAD_COLUMNSRECORD_WIDTHTREE_LIST_ENDWRITE_COLUMNSAmbiguousSpeciesErrorFieldWidthErrorSpeciesErrorTreeListFieldsUnknownSpeciesErrorresolve_species()write_tree_file()write_tree_list()write_tree_record()- The source is the authority
REGIONSSUBZONESSUPPORTED_ZONESUNSUPPORTED_ZONESBecCodeBecCodeError- The archive is public
- What is in the weights
SPECIES_GROUPSCalibrationDataErrorCalibrationDatasetManifestbuild_dataset()species_crosswalk()species_envelope()- Why the pins are part of the bundle
- The domain
- The fields
CALIBRATION_KEYWORDSMANAGEMENT_REGIMESBundleBoundsErrorBundleDomainBundleDomainErrorBundleErrorBundleParameterCalibrationBundleload_bundle()CROWN_BY_CLASSSPECIES_ALIASESclasses_for()compare_rows()keywords_for()psp_tree_records()run_backtest()select_intervals()summarise()summary_for_year()ENVELOPE_FLAGSenvelope_flags()load_envelope()- What the table is
STOPis not in the table, and is still a keyword- The misspelling
- What this module does not do
BLANK_SLOTSBLOCK_BODIESBLOCK_KEYWORDSBODY_KEYWORDSESTAB_KEYWORDSFIELD_WIDTHFIRE_MODEL_ORDER_WARNINGFMIN_KEYWORDSKEYWORDSKEYWORD_BLOCK_KEYWORDSKEYWORD_TABLELINES_KEYWORDSMISSPELLED_KEYWORDMISTOE_KEYWORDSRDIN_KEYWORDSRECORD_KEYWORDSSPECIAL_KEYWORDSSTAND_KEYWORDSSUPPLEMENTAL_KEYWORDSKeywordKeywordOrderErrorKeywordSetKeywordWidthErrorUnknownKeywordErrorUnsupportedKeywordErrorkeyword_set_hash()render_keyword()render_keywords()validate_keyword()validate_keywords()- Three things the adapter cannot take from the population
- The crown ratio is a conversion, not a copy
CROWN_CLASS_MINCrownRatioErrorMissingAssignmentErrorPlotFieldsPopulationErrorcrown_class()crown_percent()to_tree_list()- What the run actually gives, and why this reader is shaped this way
FVS_Erroris not an error channel onlyCASES_COLUMNSDATABASE_TABLESERROR_COLUMNSIDENTITY_COLUMNORACLE_TABLESREFERENCE_VERIFIEDSTANDALONE_VERIFIEDMissingOutputErrorOutputErrorRunFailedErrorSeverityUnknownTableErrorcheck_run()errors_in()read_cases()read_errors()read_table()severity_of()warnings_in()- The build’s variant list is exposed at run time
- Why the hashes are not file hashes
FVS_SOURCE_COMMITPYFVS_COMMITBuildErrorProvenanceProvenanceErrorbuilt_variants()from_cases()treelist_hash()- What the orchestration writes, and what it refuses
- The keyword hash covers what FVS read
DATABASE_NAMEKEYWORD_FILE_NAMEPROVENANCE_FILE_NAMESUMMARY_FILE_NAMETREEFMT_LINESExtensionUnavailableErrorKeywordConflictErrorRunErrorRunResultdatabase_path()run_case()run_population()tree_file_name()treelist_format_lines()with_tree_handoff()EXIT_BAD_INPUTEXIT_FAILED_RUNEXIT_OKCommandInputErrormain()
check_workflowdashboard