Welcome to pypims’s documentation

Pypims: A python-based integrated toolchain for high-performance flood simulation and data processing.

Table of Content:

• About
  • About Pypims
  • About HiPIMS-CUDA
  • References
  • Joining the community
• Getting started
  • Installing
    • Installing on Linux
    • Installing on Windows
  • Running a simulation with the example
• Tutorials
  • A tutorial for running a flood simulation
    • Explaining the data
    • Generating the inputs and runing the simulation
    • Plotting the results
• API documentation
  • Demo functions
  • demo_input()
  • demo_output()
  • demo_raster()
  • get_sample_data()
  • InputHipims
  • InputHipims
    • InputHipims.num_of_sections
    • InputHipims.shape
    • InputHipims.header
    • InputHipims.__attributes_default
    • InputHipims.attributes
    • InputHipims.times
    • InputHipims.device_no
    • InputHipims.param_per_landcover
    • InputHipims.Sections
    • InputHipims.Boundary
    • InputHipims.DEM
    • InputHipims.Rainfall
    • InputHipims.Landcover
    • InputHipims.Summary
    • InputHipims.__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()
  • InputHipimsSub
    • InputHipimsSub.sectionNO
    • InputHipimsSub._valid_cell_subs
    • InputHipimsSub.valid_cell_subsOnGlobal
    • InputHipimsSub.shared_cells_id
    • InputHipimsSub.case_folder
    • InputHipimsSub._outline_cell_subs
  • load_input_object()
  • OutputHipims
  • OutputHipims
    • OutputHipims.case_folder
    • OutputHipims.input_folder
    • OutputHipims.output_folder
    • OutputHipims.number_of_sections
    • OutputHipims.header
    • OutputHipims.header_list
    • OutputHipims.ref_datetime
    • OutputHipims.times_simu
    • OutputHipims.gauge_values_all
    • OutputHipims.gauge_values
    • OutputHipims.grid_results
    • OutputHipims.__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
    • Boundary.num_of_bound
    • Boundary.type
    • Boundary.extent
    • Boundary.hSources
    • Boundary.hUSources
    • Boundary.h_code
    • Boundary.hU_code
    • Boundary.description
    • Boundary.__init__()
    • Boundary.get_summary()
    • Boundary.print_summary()
  • Landcover
  • Landcover
    • Landcover.mask_header
    • Landcover.mask_dict
    • Landcover.__init__()
    • Landcover.get_mask_array()
    • Landcover.to_grid_parameter()
  • Raster
  • Raster
    • Raster.source_file
    • Raster.output_file
    • Raster.array
    • Raster.header
    • Raster.extent
    • Raster.shape
    • Raster.cellsize
    • Raster.extent_dict
    • Raster.wkt
    • Raster.__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
  • Rainfall
    • Rainfall.time_s
    • Rainfall.mask_header
    • Rainfall.mask_dict
    • Rainfall.rain_rate
    • Rainfall.attrs
    • Rainfall.subs_in
    • Rainfall.start_date
    • Rainfall.time_dt
    • Rainfall.__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
  • Summary
    • Summary.grid_attr
    • Summary.model_attr
    • Summary.boundary_attr
    • Summary.rain_attr
    • Summary.params_attr
    • Summary.initial_attr
    • Summary.display()
    • Summary.set_grid_attr()
    • Summary.set_model_attr()
    • Summary.set_rain_attr()
    • Summary.to_dict()
    • Summary.to_json()
  • load_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()

Indices and tables

• Index

• Module Index

• Search Page