Welcome to pypims’s documentation
Pypims: A python-based integrated toolchain for high-performance flood simulation and data processing.
Table of Content:
- About
- Getting started
- Tutorials
- API documentation
- Demo functions
demo_input()demo_output()demo_raster()get_sample_data()- InputHipims
InputHipimsInputHipims.num_of_sectionsInputHipims.shapeInputHipims.headerInputHipims.__attributes_defaultInputHipims.attributesInputHipims.timesInputHipims.device_noInputHipims.param_per_landcoverInputHipims.SectionsInputHipims.BoundaryInputHipims.DEMInputHipims.RainfallInputHipims.LandcoverInputHipims.SummaryInputHipims.__init__()InputHipims.add_user_defined_parameter()InputHipims.domain_show()InputHipims.get_case_folder()InputHipims.get_data_folders()InputHipims.get_input_filenames()InputHipims.plot_rainfall_curve()InputHipims.plot_rainfall_map()InputHipims.save_object()InputHipims.set_boundary_condition()InputHipims.set_case_folder()InputHipims.set_device_no()InputHipims.set_gauges_position()InputHipims.set_grid_parameter()InputHipims.set_initial_condition()InputHipims.set_landcover()InputHipims.set_num_of_sections()InputHipims.set_rainfall()InputHipims.set_runtime()InputHipims.write_boundary_conditions()InputHipims.write_device_file()InputHipims.write_gauges_position()InputHipims.write_grid_files()InputHipims.write_halo_file()InputHipims.write_input_files()InputHipims.write_mesh_file()InputHipims.write_rainfall_source()InputHipims.write_runtime_file()
InputHipimsSubload_input_object()- OutputHipims
OutputHipimsOutputHipims.case_folderOutputHipims.input_folderOutputHipims.output_folderOutputHipims.number_of_sectionsOutputHipims.headerOutputHipims.header_listOutputHipims.ref_datetimeOutputHipims.times_simuOutputHipims.gauge_values_allOutputHipims.gauge_valuesOutputHipims.grid_resultsOutputHipims.__init__()OutputHipims.add_gauge_results()OutputHipims.add_grid_results()OutputHipims.read_gauges_file()OutputHipims.read_grid_file()OutputHipims.save_object()OutputHipims.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()