River Architect
Software setup
Usage (Quick Start)
Get started, terminology and signposts
Modules
Tools
FAQ
Troubleshooting and error message handling
Development
About
River Architect
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
|
Z
A
activate_sample_data() (in module riverarchitect.guide)
add_background_layers() (riverarchitect.mapping.Mapper method)
add_map_raster() (riverarchitect.mapping.Mapper method)
add_shapefiles() (riverarchitect.mapping.Mapper method)
align() (in module riverarchitect.raster)
align_condition() (in module riverarchitect.preprocessing)
all_depth_rasters() (riverarchitect.condition.Condition method)
all_velocity_rasters() (riverarchitect.condition.Condition method)
annual_peaks() (riverarchitect.flows.FlowSeries method)
apply_curve() (in module riverarchitect.sharc)
apply_feature() (riverarchitect.terraforming.Terraforming method)
apply_style() (riverarchitect.mapping.Mapper method)
area_unit() (in module riverarchitect.config)
as_text() (in module riverarchitect.guide)
B
bed_preparation() (riverarchitect.recruitment.RecruitmentPotential method)
bed_shear_stress() (in module riverarchitect.preprocessing)
build() (riverarchitect.riverbuilder.RiverBuilder method)
build_layout() (riverarchitect.mapping.Mapper method)
build_paletted_qml() (in module riverarchitect.tools.lyrx2qml)
build_product() (in module riverarchitect.preprocessing)
build_pseudocolor_qml() (in module riverarchitect.tools.lyrx2qml)
C
calculate_taux() (in module riverarchitect.shear)
cell_size() (in module riverarchitect.raster)
cell_statistics() (in module riverarchitect.raster)
CFS2CMS (in module riverarchitect.config)
choose_directory() (riverarchitect.gui.qt.base.RaTab method)
choose_file() (riverarchitect.gui.qt.base.RaTab method)
choose_map_layer() (riverarchitect.mapping.Mapper method)
choose_project_home() (riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
choose_ref_layer() (riverarchitect.mapping.Mapper method)
choose_ref_layout() (riverarchitect.mapping.Mapper method)
cim_color_to_rgba() (in module riverarchitect.tools.lyrx2qml)
classifiable() (riverarchitect.preprocessing.MorphologicalUnits method)
codes() (riverarchitect.preprocessing.MorphologicalUnits method)
COMBINE_METHODS (in module riverarchitect.sharc)
composite_hsi() (riverarchitect.sharc.SHArC method)
con() (in module riverarchitect.raster)
Condition (class in riverarchitect.condition)
CONDITION (in module riverarchitect.guide)
convert() (in module riverarchitect.tools.lyrx2qml)
COST_ITEMS (in module riverarchitect.projectmaker)
cost_items() (in module riverarchitect.projectmaker)
CostItem (class in riverarchitect.projectmaker)
costs() (riverarchitect.projectmaker.ProjectMaker method)
cover_hsi() (in module riverarchitect.sharc)
cover_layers() (riverarchitect.sharc.SHArC method)
COVER_TYPES (in module riverarchitect.sharc)
cover_value() (riverarchitect.sharc.FishDatabase method)
COVER_WINDOW (in module riverarchitect.sharc)
coverage_layer() (riverarchitect.mapping.Mapper method)
critical_grain_size() (riverarchitect.lifespan.LifespanDesign method)
crop_area() (riverarchitect.recruitment.RecruitmentPotential method)
CROSS_SECTIONS (in module riverarchitect.riverbuilder)
curve() (riverarchitect.sharc.FishDatabase method)
D
D84_FACTOR (in module riverarchitect.shear)
d84_of() (in module riverarchitect.shear)
date_in() (riverarchitect.recruitment.RecruitmentParameters method)
DEFAULT_D2W_MAX (in module riverarchitect.terraforming)
DEFAULTS (in module riverarchitect.riverbuilder)
dem (riverarchitect.recruitment.RecruitmentPotential property)
dependencies_available() (in module riverarchitect.tools.reconcile_nodata)
depth_raster_for() (riverarchitect.condition.Condition method)
depth_to_water_table() (in module riverarchitect.preprocessing)
describe() (riverarchitect.condition.Condition method)
detrended_dem() (in module riverarchitect.preprocessing)
difference() (riverarchitect.volume_assessment.VolumeAssessment method)
dir_conditions() (in module riverarchitect.config)
dir_flows() (in module riverarchitect.config)
dir_maps() (in module riverarchitect.config)
dir_output() (in module riverarchitect.config)
discharge_label() (in module riverarchitect.condition)
discharge_of() (riverarchitect.condition.Condition static method)
discharge_token() (in module riverarchitect.condition)
discharges (riverarchitect.sharc.SHArC property)
disconnected_mask() (in module riverarchitect.raster)
DOCS_URL (in module riverarchitect.guide)
duration_curve() (riverarchitect.flows.FlowSeries method)
E
elide() (riverarchitect.gui.qt.base.RaTab static method)
environment variable
QGIS_PREFIX_PATH
,
[1]
RIVERARCHITECT_HOME
,
[1]
RIVERARCHITECT_QGIS_PATH
escape_routes() (riverarchitect.stranding.StrandingRisk method)
exceedance_of() (riverarchitect.flows.FlowSeries method)
exec_app() (in module riverarchitect.gui.qt.qtcompat)
exec_dialog() (in module riverarchitect.gui.qt.qtcompat)
exists() (riverarchitect.condition.Condition method)
extract_by_mask() (in module riverarchitect.raster)
F
fail() (riverarchitect.gui.qt.base.RaTab method)
Feature (class in riverarchitect.lifespan)
feature_groups() (in module riverarchitect.lifespan)
feature_ids (riverarchitect.maxlifespan.MaxLifespan property)
FEATURES (in module riverarchitect.lifespan)
find_colorizer() (in module riverarchitect.tools.lyrx2qml)
fish (riverarchitect.flows.FlowSeries property)
FishDatabase (class in riverarchitect.sharc)
FlowSeries (class in riverarchitect.flows)
for_fish() (riverarchitect.stranding.StrandingRisk class method)
from_workbook() (riverarchitect.recruitment.RecruitmentParameters class method)
FT2_PER_ACRE (in module riverarchitect.projectmaker)
FT2AC (in module riverarchitect.config)
FT2M (in module riverarchitect.config)
FUNCTION_TYPES (in module riverarchitect.riverbuilder)
G
G_SI (in module riverarchitect.shear)
get_input_ras_dir() (riverarchitect.mapping.Mapper method)
get_raster_extent() (riverarchitect.mapping.Mapper method)
GRAIN_SIZE_LIMITS (in module riverarchitect.sharc)
gravity_of() (in module riverarchitect.shear)
GuideStep (class in riverarchitect.guide)
GUMBEL_EULER (in module riverarchitect.flows)
H
h_over_ks (riverarchitect.shear.ShearResult attribute)
habitat_gain() (riverarchitect.projectmaker.ProjectMaker static method)
HIGH_LIMIT (in module riverarchitect.shear)
hydraulic_pairs() (riverarchitect.condition.Condition method)
I
idw() (in module riverarchitect.raster)
interpolated_depth() (in module riverarchitect.preprocessing)
INTERPOLATION_METHODS (in module riverarchitect.preprocessing)
is_null() (in module riverarchitect.raster)
K
keulegan_velocity_ratio() (in module riverarchitect.shear)
kriging() (in module riverarchitect.raster)
KS_FACTOR (in module riverarchitect.shear)
L
label_regions() (in module riverarchitect.raster)
LifespanDesign (class in riverarchitect.lifespan)
lifestage (riverarchitect.stranding.StrandingRisk attribute)
lifestages() (riverarchitect.sharc.FishDatabase method)
list_rasters() (in module riverarchitect.raster)
load_threshold_workbook() (in module riverarchitect.lifespan)
LOG_LENGTH (in module riverarchitect.projectmaker)
LOW_LIMIT (in module riverarchitect.shear)
M
main() (in module riverarchitect.gui.main)
(in module riverarchitect.tools.lyrx2qml)
(in module riverarchitect.tools.reconcile_nodata)
main_channel() (riverarchitect.stranding.StrandingRisk method)
make_pdf_maps() (riverarchitect.mapping.Mapper method)
make_xy_centerpoints() (riverarchitect.mapping.Mapper method)
Mapper (class in riverarchitect.mapping)
max_lifespan (riverarchitect.condition.Condition property)
MaxLifespan (class in riverarchitect.maxlifespan)
MINERAL_COVER (in module riverarchitect.sharc)
MINERAL_COVER_RULES (in module riverarchitect.sharc)
module
riverarchitect.condition
riverarchitect.config
riverarchitect.flows
riverarchitect.gui.base
riverarchitect.gui.main
riverarchitect.gui.qt.base
riverarchitect.gui.qt.main
riverarchitect.gui.qt.qtcompat
riverarchitect.guide
riverarchitect.lifespan
riverarchitect.mapping
riverarchitect.maxlifespan
riverarchitect.preprocessing
riverarchitect.projectmaker
riverarchitect.raster
riverarchitect.recruitment
riverarchitect.riverbuilder
riverarchitect.sharc
riverarchitect.shear
riverarchitect.stranding
riverarchitect.terraforming
riverarchitect.tools.lyrx2qml
riverarchitect.tools.reconcile_nodata
riverarchitect.volume
riverarchitect.volume_assessment
morphological_units() (in module riverarchitect.preprocessing)
MorphologicalUnits (class in riverarchitect.preprocessing)
MU_ALIASES (in module riverarchitect.preprocessing)
N
nearest_neighbour() (in module riverarchitect.raster)
NODATA (in module riverarchitect.config)
O
on_project_home_change() (riverarchitect.gui.base.RaModuleGui method)
(riverarchitect.gui.qt.base.RaTab method)
on_unit_change() (riverarchitect.gui.base.RaModuleGui method)
(riverarchitect.gui.qt.base.RaTab method)
open_documentation() (riverarchitect.gui.main.RiverArchitectGui static method)
(riverarchitect.gui.qt.main.RiverArchitectWindow static method)
open_live_guide() (riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
open_project() (riverarchitect.mapping.Mapper method)
P
package_dir() (in module riverarchitect.config)
pairs() (riverarchitect.sharc.FishDatabase method)
paragraphs() (riverarchitect.guide.GuideStep method)
PARAMETERS (in module riverarchitect.riverbuilder)
parse() (riverarchitect.riverbuilder.UserFunction class method)
parse_input_definitions() (in module riverarchitect.condition)
path() (riverarchitect.condition.Condition method)
planting_depth_limit() (in module riverarchitect.terraforming)
point_cloud() (riverarchitect.riverbuilder.RiverBuilder method)
polygonize() (in module riverarchitect.raster)
prepare_layout() (riverarchitect.mapping.Mapper method)
PRODUCTS (in module riverarchitect.preprocessing)
profile_of() (in module riverarchitect.raster)
project_home() (in module riverarchitect.config)
project_path() (riverarchitect.mapping.Mapper method)
ProjectMaker (class in riverarchitect.projectmaker)
Q
q_mobile() (riverarchitect.recruitment.RecruitmentPotential method)
QGIS_BINDINGS_PATH (in module riverarchitect.mapping)
qgis_candidates() (in module riverarchitect.mapping)
QGIS_LAYOUTS (in module riverarchitect.mapping)
QGIS_PREFIX (in module riverarchitect.mapping)
QGIS_PREFIX_PATH
,
[1]
qgis_status() (in module riverarchitect.mapping)
QgisSession (class in riverarchitect.mapping)
quantities_from_lifespan() (riverarchitect.projectmaker.ProjectMaker method)
quit_program() (riverarchitect.gui.main.RiverArchitectGui method)
R
RaModuleGui (class in riverarchitect.gui.base)
raster_to_points() (in module riverarchitect.raster)
rasterize() (in module riverarchitect.raster)
RaTab (class in riverarchitect.gui.qt.base)
rate_for() (riverarchitect.projectmaker.CostItem method)
RATES (in module riverarchitect.projectmaker)
read() (in module riverarchitect.raster)
(riverarchitect.riverbuilder.RiverBuilderInput class method)
read_flow_series() (in module riverarchitect.flows)
(in module riverarchitect.recruitment)
recession_and_inundation() (riverarchitect.recruitment.RecruitmentPotential method)
reclassify() (in module riverarchitect.raster)
reconcile() (in module riverarchitect.tools.reconcile_nodata)
RecruitmentParameters (class in riverarchitect.recruitment)
RecruitmentPotential (class in riverarchitect.recruitment)
refresh_conditions() (riverarchitect.gui.base.RaModuleGui method)
(riverarchitect.gui.qt.base.RaTab method)
regime (riverarchitect.shear.ShearResult attribute)
REGIME_LABELS (in module riverarchitect.shear)
regime_summary() (in module riverarchitect.shear)
remove_sidecars() (in module riverarchitect.tools.reconcile_nodata)
representable() (in module riverarchitect.tools.reconcile_nodata)
resample() (in module riverarchitect.raster)
resolve_lifestage() (riverarchitect.sharc.FishDatabase method)
resolve_species() (riverarchitect.sharc.FishDatabase method)
return_periods() (in module riverarchitect.flows)
RHO_RATIO (in module riverarchitect.shear)
rickenmann_recking_velocity_ratio() (in module riverarchitect.shear)
riverarchitect.condition
module
riverarchitect.config
module
riverarchitect.flows
module
riverarchitect.gui.base
module
riverarchitect.gui.main
module
riverarchitect.gui.qt.base
module
riverarchitect.gui.qt.main
module
riverarchitect.gui.qt.qtcompat
module
riverarchitect.guide
module
riverarchitect.lifespan
module
riverarchitect.mapping
module
riverarchitect.maxlifespan
module
riverarchitect.preprocessing
module
riverarchitect.projectmaker
module
riverarchitect.raster
module
riverarchitect.recruitment
module
riverarchitect.riverbuilder
module
riverarchitect.sharc
module
riverarchitect.shear
module
riverarchitect.stranding
module
riverarchitect.terraforming
module
riverarchitect.tools.lyrx2qml
module
riverarchitect.tools.reconcile_nodata
module
riverarchitect.volume
module
riverarchitect.volume_assessment
module
RIVERARCHITECT_HOME
,
[1]
RIVERARCHITECT_QGIS_PATH
RiverArchitectGui (class in riverarchitect.gui.main)
RiverArchitectWindow (class in riverarchitect.gui.qt.main)
RiverBuilder (class in riverarchitect.riverbuilder)
RiverBuilderInput (class in riverarchitect.riverbuilder)
run() (in module riverarchitect.gui.qt.main)
(riverarchitect.lifespan.LifespanDesign method)
(riverarchitect.maxlifespan.MaxLifespan method)
(riverarchitect.projectmaker.ProjectMaker method)
(riverarchitect.recruitment.RecruitmentPotential method)
(riverarchitect.riverbuilder.RiverBuilder method)
(riverarchitect.sharc.SHArC method)
(riverarchitect.stranding.StrandingRisk method)
(riverarchitect.terraforming.Terraforming method)
(riverarchitect.volume_assessment.VolumeAssessment method)
run_feature() (riverarchitect.lifespan.LifespanDesign method)
run_in_background() (riverarchitect.gui.qt.base.RaTab method)
run_reconcile_nodata() (riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
S
sample_data_dir() (in module riverarchitect.guide)
sample_data_status() (in module riverarchitect.guide)
save_project() (riverarchitect.mapping.Mapper method)
scour_survival() (riverarchitect.recruitment.RecruitmentPotential method)
season_dates() (riverarchitect.sharc.FishDatabase method)
season_flows() (riverarchitect.flows.FlowSeries method)
seasonal_flow_duration() (in module riverarchitect.flows)
select_tab() (riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
set_background() (riverarchitect.gui.base.RaModuleGui static method)
set_null() (in module riverarchitect.raster)
set_project_home() (in module riverarchitect.config)
set_unit() (riverarchitect.gui.base.RaModuleGui method)
(riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.base.RaTab method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
SHArC (class in riverarchitect.sharc)
sharea() (riverarchitect.sharc.SHArC static method)
ShearResult (class in riverarchitect.shear)
shields_stress() (riverarchitect.lifespan.LifespanDesign method)
(riverarchitect.recruitment.RecruitmentPotential method)
shortname() (riverarchitect.sharc.FishDatabase static method)
show_about() (riverarchitect.gui.main.RiverArchitectGui method)
(riverarchitect.gui.qt.main.RiverArchitectWindow method)
slope() (in module riverarchitect.raster)
smoothstep_weight() (in module riverarchitect.shear)
species (riverarchitect.stranding.StrandingRisk attribute)
start() (riverarchitect.mapping.QgisSession class method)
stop() (riverarchitect.mapping.QgisSession class method)
StrandingRisk (class in riverarchitect.stranding)
style_file() (riverarchitect.mapping.Mapper method)
subtitle (riverarchitect.gui.qt.base.RaTab attribute)
surface_volume() (in module riverarchitect.volume)
symbology_dir() (in module riverarchitect.config)
T
TAB_GROUPS (in module riverarchitect.gui.main)
(in module riverarchitect.gui.qt.main)
TABS (in module riverarchitect.gui.qt.main)
tabulate_area() (in module riverarchitect.raster)
target_dtype() (in module riverarchitect.tools.reconcile_nodata)
templates_dir() (in module riverarchitect.config)
Terraforming (class in riverarchitect.terraforming)
theta84 (riverarchitect.shear.ShearResult attribute)
TITLE (in module riverarchitect.guide)
title (riverarchitect.gui.base.RaModuleGui attribute)
(riverarchitect.gui.qt.base.RaTab attribute)
to_raster() (riverarchitect.riverbuilder.RiverBuilder method)
token_for() (riverarchitect.condition.Condition method)
TRAVEL_THRESHOLDS (in module riverarchitect.stranding)
travel_thresholds() (in module riverarchitect.stranding)
(riverarchitect.sharc.FishDatabase method)
U
unit_for() (riverarchitect.projectmaker.CostItem method)
unit_labels() (in module riverarchitect.config)
UNITS (in module riverarchitect.config)
usable_area() (riverarchitect.sharc.SHArC method)
UserFunction (class in riverarchitect.riverbuilder)
ustar2 (riverarchitect.shear.ShearResult attribute)
V
validate() (riverarchitect.condition.Condition method)
VARIABILITY (riverarchitect.riverbuilder.RiverBuilderInput attribute)
velocity_components() (riverarchitect.stranding.StrandingRisk method)
velocity_limited (riverarchitect.stranding.StrandingRisk property)
velocity_raster_for() (riverarchitect.condition.Condition method)
VolumeAssessment (class in riverarchitect.volume_assessment)
volumes() (riverarchitect.volume_assessment.VolumeAssessment method)
W
warn() (riverarchitect.gui.qt.base.RaTab method)
water_level_elevation() (in module riverarchitect.preprocessing)
within_radius() (in module riverarchitect.raster)
wle_at() (riverarchitect.recruitment.RecruitmentPotential method)
wle_for() (riverarchitect.recruitment.RecruitmentPotential method)
write() (in module riverarchitect.raster)
(riverarchitect.riverbuilder.RiverBuilderInput method)
write_flow_duration() (riverarchitect.flows.FlowSeries method)
write_input_definitions() (in module riverarchitect.preprocessing)
write_pools() (riverarchitect.stranding.StrandingRisk method)
write_rasters() (riverarchitect.volume_assessment.VolumeAssessment method)
write_report() (riverarchitect.projectmaker.ProjectMaker method)
write_shear_diagnostics() (riverarchitect.lifespan.LifespanDesign method)
Y
years (riverarchitect.flows.FlowSeries property)
Z
zonal_statistics() (in module riverarchitect.raster)
zoom2map() (riverarchitect.mapping.Mapper method)