Welcome to synxflow’s documentation
SynxFlow: Synergising High-Performance Hazard Simulation with Data Flow
Table of Content:
- About
- Getting started
- Tutorials
- API documentation
- Demo functions
demo_input()demo_output()demo_raster()get_sample_data()- InputModel
InputModelInputModel.num_of_sectionsInputModel.shapeInputModel.headerInputModel.__attributes_defaultInputModel.attributesInputModel.timesInputModel.device_noInputModel.param_per_landcoverInputModel.SectionsInputModel.BoundaryInputModel.DEMInputModel.RainfallInputModel.LandcoverInputModel.SummaryInputModel.__init__()InputModel.add_user_defined_parameter()InputModel.domain_show()InputModel.get_case_folder()InputModel.get_data_folders()InputModel.get_input_filenames()InputModel.plot_rainfall_curve()InputModel.plot_rainfall_map()InputModel.save_object()InputModel.set_boundary_condition()InputModel.set_case_folder()InputModel.set_device_no()InputModel.set_gauges_position()InputModel.set_grid_parameter()InputModel.set_initial_condition()InputModel.set_landcover()InputModel.set_num_of_sections()InputModel.set_rainfall()InputModel.set_runtime()InputModel.write_boundary_conditions()InputModel.write_device_file()InputModel.write_gauges_position()InputModel.write_grid_files()InputModel.write_halo_file()InputModel.write_input_files()InputModel.write_landslide_config()InputModel.write_mesh_file()InputModel.write_rainfall_source()InputModel.write_runtime_file()
InputModelSubload_input_object()- OutputModel
OutputModelOutputModel.case_folderOutputModel.input_folderOutputModel.output_folderOutputModel.number_of_sectionsOutputModel.headerOutputModel.header_listOutputModel.ref_datetimeOutputModel.times_simuOutputModel.gauge_values_allOutputModel.gauge_valuesOutputModel.grid_resultsOutputModel.__init__()OutputModel.add_gauge_results()OutputModel.add_grid_results()OutputModel.read_gauges_file()OutputModel.read_grid_file()OutputModel.save_object()OutputModel.set_ref_datetime()
load_output_object()- Boundary
Boundary- Landcover
Landcover- Raster
RasterRaster.source_fileRaster.output_fileRaster.arrayRaster.headerRaster.extentRaster.shapeRaster.cellsizeRaster.extent_dictRaster.wktRaster.__init__()Raster.assign_to()Raster.clip()Raster.get_meta()Raster.get_summary()Raster.grid_interpolate()Raster.grid_resample_nearest()Raster.hillshade()Raster.mapshow()Raster.paste_on()Raster.point_interpolate()Raster.rankshow()Raster.rasterize()Raster.rect_clip()Raster.reproject()Raster.resample()Raster.set_crs()Raster.to_points()Raster.vectorshow()Raster.write()Raster.write_asc()Raster.write_tif()
main()merge()- Rainfall
RainfallRainfall.time_sRainfall.mask_headerRainfall.mask_dictRainfall.rain_rateRainfall.attrsRainfall.subs_inRainfall.start_dateRainfall.time_dtRainfall.__init__()Rainfall.get_attrs()Rainfall.get_mask_array()Rainfall.get_source_array()Rainfall.get_spatial_map()Rainfall.get_time_series()Rainfall.get_valid_rain_rate()Rainfall.plot_rainfall_map()Rainfall.plot_time_series()Rainfall.set_mask()Rainfall.set_source()Rainfall.set_start_date()
- Summary
Summaryload_summary()- rainfall_processing
create_animation()create_pictures()get_spatial_map()get_time_series()plot_time_series()- grid_show
hillshade()make_gif()make_mp4()mapshow()plot_shape_file()rankshow()vectorshow()- spatial_analysis
arc_header_read()arcgridread()arcgridwrite()byte_file_read()check_file_existence()combine_raster()compare_extent()extent2shape_points()header2extent()hillshade_show()map2sub()map_show()rank_show()shape_extent_to_header()sub2map()tif_read()- Independent functions
clean_output()load_object()save_as_dict()save_object()write_device_setup()write_rain_source()write_times_setup()