schimpy

• schimpy package
  • Submodules
  • schimpy.archive_ts module
  • schimpy.base_io module
    • BaseIO
      • BaseIO.linecounter
  • schimpy.batch_metrics module
  • schimpy.bctide module
  • schimpy.bound_linear module
    • bound_linear()
  • schimpy.cencoos_download module
    • cencoos_schism_opendap()
    • merc_to_latlon()
    • time_block_report()
  • schimpy.check_mesh_skewness module
  • schimpy.clip_dems module
    • bounding_coords()
    • clip_dem()
    • create_arg_parser()
    • main()
  • schimpy.combine_consume module
    • appears_done()
    • archive_blocks()
    • combine()
    • combine_consume()
    • combine_hotstart()
    • create_arg_parser()
    • detect_min_max_index()
    • do_combine()
    • do_combine_hotstart()
    • failed_incomplete()
    • gather_ppf_names()
    • main()
    • prune_ppf_files()
    • setup()
    • split()
    • touch()
  • schimpy.combine_flux module
    • combine_flux()
    • create_arg_parser()
    • main()
    • test_combine_flux()
  • schimpy.contour_smooth module
    • RasterWrapper
      • RasterWrapper.write_copy()
    • calc_f()
    • contour_smooth()
    • contour_smooth2d()
    • create_arg_parser()
    • main()
    • save_smooth()
    • view_smooth()
  • schimpy.convert_linestrings module
    • create_arg_parser()
    • main()
  • schimpy.convert_mesh module
  • schimpy.convert_points module
  • schimpy.convert_polygons module
    • create_arg_parser()
    • main()
  • schimpy.convert_sav_class_to_number module
  • schimpy.create_mesh_n_levels module
  • schimpy.create_vgrid_lsc2 module
  • schimpy.cruise module
    • create_arg_parser()
    • cruise_xyt()
    • do_depth_plot()
    • gen_profile_plot()
    • gen_station_xyt()
    • longitudinal()
    • main()
    • match_cruise()
    • model_data_for_longitude()
    • process_cruise()
    • process_stations()
    • process_xyt()
  • schimpy.cut_mesh module
  • schimpy.download_hrrr module
    • create_arg_parser()
    • download_hrr()
    • main()
  • schimpy.embed_raster module
    • create_arg_parser()
    • embed_raster()
  • schimpy.gaussian_quadrature module
    • GaussianQuadrature
      • GaussianQuadrature.average()
      • GaussianQuadrature.calculate_quadrature_points_and_weights()
      • GaussianQuadrature.domain_size()
      • GaussianQuadrature.integrate()
      • GaussianQuadrature.jacobian_det()
      • GaussianQuadrature.number_of_quadrature_points()
      • GaussianQuadrature.quadrature_vector()
      • GaussianQuadrature.shape()
      • GaussianQuadrature.shape_derivative()
      • GaussianQuadrature.values_at_quadrature_points()
    • GaussianQuadratureLine2
      • GaussianQuadratureLine2.average()
      • GaussianQuadratureLine2.calculate_quadrature_points_and_weights()
      • GaussianQuadratureLine2.domain_size()
      • GaussianQuadratureLine2.jacobian_det()
      • GaussianQuadratureLine2.shape()
      • GaussianQuadratureLine2.shape_derivative()
    • GaussianQuadratureQuad4
      • GaussianQuadratureQuad4.calculate_quadrature_points_and_weights()
      • GaussianQuadratureQuad4.domain_size()
      • GaussianQuadratureQuad4.jacobian()
      • GaussianQuadratureQuad4.shape()
      • GaussianQuadratureQuad4.shape_derivative()
    • GaussianQuadratureTri3
      • GaussianQuadratureTri3.calculate_quadrature_points_and_weights()
      • GaussianQuadratureTri3.domain_size()
      • GaussianQuadratureTri3.jacobian()
      • GaussianQuadratureTri3.jacobian_det()
      • GaussianQuadratureTri3.shape()
      • GaussianQuadratureTri3.shape_derivative()
  • schimpy.gen_elev2d module
  • schimpy.geo_tools module
    • FindMultiPoly()
    • Polylen()
    • geometry2coords()
    • geometry2coords_points()
    • ic_to_gpd()
    • ll2utm()
    • partition_check()
    • project_fun()
    • shapely_to_geopandas()
    • shp2yaml()
    • utm2ll()
    • yaml2shp()
  • schimpy.gr3 module
  • schimpy.grid_opt module
  • schimpy.hotstart_inventory module
    • create_arg_parser()
    • hotstart_inventory()
    • hotstart_inventory2()
    • main()
  • schimpy.hrr3 module
    • AWSGrib2Inventory
      • AWSGrib2Inventory.bucket
      • AWSGrib2Inventory.files
      • AWSGrib2Inventory.output_interval
      • AWSGrib2Inventory.s3
      • AWSGrib2Inventory.tmpdir
    • HRRR
      • HRRR.gen_sflux()
      • HRRR.modified_latlon()
    • localize_datetime()
    • nearest_cycle()
  • schimpy.interp_2d module
    • Invdisttree
      • Invdisttree.interp()
      • Invdisttree.weights()
  • schimpy.interpolate_structure module
    • create_arg_parser()
    • ensure_offset()
    • interpolate_structure()
    • main()
    • test_date_label_correct()
    • test_template_times()
  • schimpy.laplace_smooth_data module
    • laplace_smooth_data()
    • laplace_smooth_data2()
    • laplace_smooth_with_vel()
    • laplace_smooth_with_vel2()
    • laplace_smooth_with_vel3()
  • schimpy.lsc2 module
    • BilinearMeshDensity
      • BilinearMeshDensity.density()
      • BilinearMeshDensity.depth()
    • CubicLSC2MeshFunction
      • CubicLSC2MeshFunction.density()
      • CubicLSC2MeshFunction.depth()
    • default_num_layers()
    • default_num_layers0()
    • example()
    • example2()
    • example3()
    • flip_sigma()
    • gen_sigma()
    • label_components()
    • lowest_layer_height()
    • mesh_function_depths()
    • plot_mesh()
    • process_orphans()
    • process_orphans2()
    • sigma_z()
    • smooth_bed()
    • szcoord()
    • z_sigma()
  • schimpy.material_poly module
    • create_arg_parser()
    • create_poly()
    • read_keyfile()
  • schimpy.merge_th module
    • create_arg_parser()
    • main()
    • merge_th()
    • read_data()
    • read_locations_from_input()
    • read_th_spec()
    • write_th()
  • schimpy.metricsplot module
    • plot_comparison()
    • plot_metrics()
  • schimpy.model_time module
    • clip()
    • create_arg_parser()
    • describe_elapsed()
    • describe_timestamps()
    • file_to_elapsed()
    • file_to_timestamp()
    • main()
    • multi_file_to_elapsed()
    • prune_dated()
    • to_datetime()
    • to_elapsed()
  • schimpy.nml module
    • Namelist
    • TopLevelNamelist
    • map_to_dict()
    • map_to_object()
    • parse()
    • write()
  • schimpy.nudging module
  • schimpy.param module
    • Params
      • Params.adjust_dt()
      • Params.copy()
      • Params.diff()
      • Params.get_hotstart_freq()
      • Params.get_interval()
      • Params.get_nc_out_freq()
      • Params.get_nc_stack()
      • Params.get_run_start()
      • Params.get_station_out_freq()
      • Params.hotstart_freq
      • Params.nc_out_freq
      • Params.nc_stack
      • Params.process_default()
      • Params.run_start
      • Params.searchfor()
      • Params.sections()
      • Params.set_hotstart_freq()
      • Params.set_interval()
      • Params.set_nc_out_freq()
      • Params.set_nc_stack()
      • Params.set_run_start()
      • Params.set_station_out_freq()
      • Params.station_out_freq
      • Params.to_dataframe()
      • Params.update()
      • Params.validate()
      • Params.write()
    • param_from_template()
    • read_params()
    • test_param()
  • schimpy.params module
    • Core
      • Core.dt
      • Core.eco_class
      • Core.ibc
      • Core.ibtp
      • Core.ihfskip
      • Core.ipre
      • Core.mdc2
      • Core.msc2
      • Core.name
      • Core.nspool
      • Core.ntracer_age
      • Core.ntracer_gen
      • Core.rnday
      • Core.sed_class
    • HydroOutput
      • HydroOutput.air_pressure
      • HydroOutput.air_temperature
      • HydroOutput.barotropic_pres_grad_xy
      • HydroOutput.bottom_stress_xy
      • HydroOutput.depth_avg_vel_xy
      • HydroOutput.diffusivity
      • HydroOutput.downward_longwave
      • HydroOutput.dry_flag_node
      • HydroOutput.elevation
      • HydroOutput.evaporation_rate
      • HydroOutput.horizontal_side_vel_xy
      • HydroOutput.horizontal_vel_xy
      • HydroOutput.latent_heat
      • HydroOutput.mixing_length
      • HydroOutput.name
      • HydroOutput.precipitation_rate
      • HydroOutput.salinity
      • HydroOutput.salinity_at_element
      • HydroOutput.sensible_heat
      • HydroOutput.solar_radiation
      • HydroOutput.specific_humidity
      • HydroOutput.temperature
      • HydroOutput.temperature_at_element
      • HydroOutput.total_heat
      • HydroOutput.turbulent_kinetic_ener
      • HydroOutput.upward_longwave
      • HydroOutput.vertical_vel_at_element
      • HydroOutput.vertical_velocity
      • HydroOutput.viscosity
      • HydroOutput.water_density
      • HydroOutput.wind_speed_xy
      • HydroOutput.wind_stress_xy
      • HydroOutput.z_coordinates
    • Opt
      • Opt.alphaw
      • Opt.btrack_nudge
      • Opt.coricoef
      • Opt.courant_weno
      • Opt.cur_wwm
      • Opt.dfh0
      • Opt.dfv0
      • Opt.dramp
      • Opt.dramp_ss
      • Opt.drampbc
      • Opt.drampwafo
      • Opt.drampwind
      • Opt.dtb_max
      • Opt.dtb_min
      • Opt.dzb_min
      • Opt.eos_a
      • Opt.eos_b
      • Opt.eps1_tvd_imp
      • Opt.eps2_tvd_imp
      • Opt.epsilon1
      • Opt.epsilon2
      • Opt.epsilon3
      • Opt.flag_fib
      • Opt.flag_ic
      • Opt.fwvor_advxy_stokes
      • Opt.fwvor_advz_stokes
      • Opt.fwvor_breaking
      • Opt.fwvor_gradpress
      • Opt.fwvor_streaming
      • Opt.fwvor_wveg
      • Opt.fwvor_wveg_NL
      • Opt.gen_wsett
      • Opt.h0
      • Opt.h1_bcc
      • Opt.h1_pp
      • Opt.h2_bcc
      • Opt.h2_pp
      • Opt.h_bcc1
      • Opt.h_massconsv
      • Opt.h_tvd
      • Opt.hmin_airsea_ex
      • Opt.hmin_man
      • Opt.hmin_radstress
      • Opt.hmin_salt_ex
      • Opt.hvis_coef0
      • Opt.hw_depth
      • Opt.hw_ratio
      • Opt.i_hmin_airsea_ex
      • Opt.i_hmin_salt_ex
      • Opt.i_prtnftl_weno
      • Opt.iadjust_mass_consv0
      • Opt.ibcc_mean
      • Opt.ibdef
      • Opt.ibtrack_test
      • Opt.ic_elev
      • Opt.icou_elfe_wwm
      • Opt.ics
      • Opt.ielad_weno
      • Opt.ielm_transport
      • Opt.ieos_pres
      • Opt.ieos_type
      • Opt.if_source
      • Opt.iflux
      • Opt.iflux_out_format
      • Opt.iharind
      • Opt.ihconsv
      • Opt.ihdif
      • Opt.ihhat
      • Opt.ihorcon
      • Opt.ihot
      • Opt.ihydraulics
      • Opt.iloadtide
      • Opt.imm
      • Opt.indvel
      • Opt.inter_mom
      • Opt.inu_elev
      • Opt.inu_tr
      • Opt.inu_uv
      • Opt.inunfl
      • Opt.inv_atm_bnd
      • Opt.ip_weno
      • Opt.ipre2
      • Opt.iprecip_off_bnd
      • Opt.irouse_test
      • Opt.isav
      • Opt.isconsv
      • Opt.ishapiro
      • Opt.itr_met
      • Opt.itransport_only
      • Opt.itur
      • Opt.iunder_deep
      • Opt.iupwind_mom
      • Opt.iwbl
      • Opt.iwind_form
      • Opt.iwindoff
      • Opt.izonal5
      • Opt.kr_co
      • Opt.lev_tr_source
      • Opt.level_age
      • Opt.loadtide_coef
      • Opt.max_subcyc
      • Opt.meth_sink
      • Opt.mid
      • Opt.moitn0
      • Opt.mxitn0
      • Opt.nadv
      • Opt.name
      • Opt.nchi
      • Opt.ncor
      • Opt.niter_shap
      • Opt.nquad
      • Opt.nramp_elev
      • Opt.nstep_ice
      • Opt.nstep_wwm
      • Opt.ntd_weno
      • Opt.nu_sum_mult
      • Opt.nws
      • Opt.prmsl_ref
      • Opt.rearth_eq
      • Opt.rearth_pole
      • Opt.rho0
      • Opt.rinflation_icm
      • Opt.rlatitude
      • Opt.rmaxvel
      • Opt.rtol0
      • Opt.s1_mxnbt
      • Opt.s2_mxnbt
      • Opt.sfea0
      • Opt.shapiro0
      • Opt.shorewafo
      • Opt.shw
      • Opt.slam0
      • Opt.slr_rate
      • Opt.small_elad
      • Opt.stab
      • Opt.start_day
      • Opt.start_hour
      • Opt.start_month
      • Opt.start_year
      • Opt.step_nu_tr
      • Opt.tdmin_pp1
      • Opt.tdmin_pp2
      • Opt.thetai
      • Opt.turbinj
      • Opt.turbinjds
      • Opt.utc_start
      • Opt.vclose_surf_frac
      • Opt.vdmax_pp1
      • Opt.vdmax_pp2
      • Opt.vdmin_pp1
      • Opt.vdmin_pp2
      • Opt.velmin_btrack
      • Opt.vnf1
      • Opt.vnf2
      • Opt.vnh1
      • Opt.vnh2
      • Opt.wafo_obcramp
      • Opt.wtiminc
      • Opt.xlsc0
    • OutControls
      • OutControls.from_iof_array()
      • OutControls.get_iof_array_names()
      • OutControls.name
      • OutControls.to_iof_array()
    • Params
      • Params.core
      • Params.opt
      • Params.schout
    • Schout
      • Schout.iof_age
      • Schout.iof_ana
      • Schout.iof_cos
      • Schout.iof_dvd
      • Schout.iof_eco
      • Schout.iof_fib
      • Schout.iof_gen
      • Schout.iof_hydro
      • Schout.iof_ice
      • Schout.iof_icm_ba
      • Schout.iof_icm_cbp
      • Schout.iof_icm_core
      • Schout.iof_icm_dbg
      • Schout.iof_icm_ph
      • Schout.iof_icm_sav
      • Schout.iof_icm_sed
      • Schout.iof_icm_silica
      • Schout.iof_icm_veg
      • Schout.iof_icm_zb
      • Schout.iof_marsh
      • Schout.iof_sed
      • Schout.iof_sed2d
      • Schout.iof_ugrid
      • Schout.iof_wwm
      • Schout.iout_sta
      • Schout.name
      • Schout.nc_out
      • Schout.nhot
      • Schout.nhot_write
      • Schout.nspool_sta
    • TracerGenOutput
      • TracerGenOutput.get_tracer_names()
      • TracerGenOutput.name
      • TracerGenOutput.ntracer_gen
    • WindWaveOutput
      • WindWaveOutput.bottom_excursion_period
      • WindWaveOutput.bottom_wave_period
      • WindWaveOutput.charnock_coeff
      • WindWaveOutput.continuous_peak_period
      • WindWaveOutput.discrete_peak_direction
      • WindWaveOutput.diss_rate_bott_friction
      • WindWaveOutput.diss_rate_dep_breaking
      • WindWaveOutput.diss_rate_vegetation
      • WindWaveOutput.diss_rate_whitecapping
      • WindWaveOutput.dominant_direction
      • WindWaveOutput.energy_input_atmos
      • WindWaveOutput.frictional_velocity
      • WindWaveOutput.mean_dir_spreading
      • WindWaveOutput.mean_wave_direction
      • WindWaveOutput.mean_wave_length
      • WindWaveOutput.mean_wave_number
      • WindWaveOutput.mean_wave_period
      • WindWaveOutput.name
      • WindWaveOutput.orbital_velocity
      • WindWaveOutput.peak_group_vel
      • WindWaveOutput.peak_n_factor
      • WindWaveOutput.peak_period
      • WindWaveOutput.peak_phase_vel
      • WindWaveOutput.peak_spreading
      • WindWaveOutput.peak_wave_length
      • WindWaveOutput.peak_wave_number
      • WindWaveOutput.rms_orbital_velocity
      • WindWaveOutput.roller_diss_rate
      • WindWaveOutput.roughness_length
      • WindWaveOutput.sig_wave_height
      • WindWaveOutput.tm_10
      • WindWaveOutput.u_resell_number
      • WindWaveOutput.wave_energy_dir_x
      • WindWaveOutput.wave_energy_dir_y
      • WindWaveOutput.zero_downcross_period
    • build_iof_dict()
    • coerce_to_type()
    • create_params()
    • get_type_dict()
    • get_value_dict()
  • schimpy.plot_default_formats module
    • set_color_cycle_dark2()
    • set_dual_axes()
    • set_dual_axes_elev()
    • set_dual_axes_salt()
  • schimpy.prepare_schism module
  • schimpy.priority_queue module
    • priorityDictionary
      • priorityDictionary.setdefault()
      • priorityDictionary.smallest()
  • schimpy.profile_plot module
    • get_index_bounds()
    • nearest_neighbor_fill()
    • profile_plot()
    • set_index_bounds()
    • vertical_fill()
  • schimpy.raster_to_nodes module
    • raster_to_nodes()
  • schimpy.read_output_xyt module
    • read_depth_avg_from_output7b_xyt()
  • schimpy.schism_hotstart module
  • schimpy.schism_input module
  • schimpy.schism_linestring module
    • LineString
      • LineString.prop
    • LineStringIo
      • LineStringIo.read()
      • LineStringIo.write()
    • LineStringIoFactory
      • LineStringIoFactory.get_reader()
      • LineStringIoFactory.get_writer()
      • LineStringIoFactory.registered_readers
      • LineStringIoFactory.registered_writers
    • LineStringShapefileReader
      • LineStringShapefileReader.read()
    • LineStringShapefileWriter
      • LineStringShapefileWriter.write()
    • LineStringYamlReader
      • LineStringYamlReader.read()
    • LineStringYamlWriter
      • LineStringYamlWriter.write()
    • read_linestrings()
    • write_linestrings()
  • schimpy.schism_mesh module
  • schimpy.schism_polygon module
    • SchismPolygon
      • SchismPolygon.attribute
      • SchismPolygon.contains()
      • SchismPolygon.intersects()
      • SchismPolygon.name
      • SchismPolygon.prop
      • SchismPolygon.type
    • SchismPolygonDictConverter
      • SchismPolygonDictConverter.read()
    • SchismPolygonIo
      • SchismPolygonIo.read()
    • SchismPolygonIoFactory
      • SchismPolygonIoFactory.get_reader()
      • SchismPolygonIoFactory.get_writer()
      • SchismPolygonIoFactory.registered_readers
      • SchismPolygonIoFactory.registered_writers
      • SchismPolygonIoFactory.show_registered_readers()
    • SchismPolygonShapefileReader
      • SchismPolygonShapefileReader.read()
    • SchismPolygonShapefileWriter
      • SchismPolygonShapefileWriter.write()
    • SchismPolygonYamlReader
      • SchismPolygonYamlReader.read()
    • SchismPolygonYamlWriter
      • SchismPolygonYamlWriter.write()
    • read_polygons()
    • write_polygons()
  • schimpy.schism_setup module
  • schimpy.schism_source module
    • SchismSource
      • SchismSource.coord
      • SchismSource.element_id
      • SchismSource.note
      • SchismSource.type
    • SchismSourceIO
      • SchismSourceIO.read()
      • SchismSourceIO.write()
    • read_sources()
  • schimpy.schism_sources_sinks module
  • schimpy.schism_structure module
    • SchismStructure
      • SchismStructure.coords
      • SchismStructure.n_duplicate
      • SchismStructure.n_node_pairs()
      • SchismStructure.name
      • SchismStructure.node_pairs
      • SchismStructure.properties
      • SchismStructure.reference
      • SchismStructure.reference_pair
      • SchismStructure.type
      • SchismStructure.use_timeseries
    • SchismStructureIO
      • SchismStructureIO.read()
      • SchismStructureIO.write()
  • schimpy.schism_vertical_mesh module
    • read_vmesh()
  • schimpy.schism_yaml module
    • ArgumentParserYaml
    • YamlAction
    • dump()
    • load()
  • schimpy.separate_species module
    • create_arg_parser()
    • main()
    • plot_result()
    • run_example()
    • separate_species()
    • write_th()
  • schimpy.simulation_timing module
    • create_arg_parser()
    • schism_timing()
  • schimpy.small_areas module
  • schimpy.sms2gr3 module
    • Boundary
    • addnode()
    • convert_2dm()
    • create_arg_parser()
  • schimpy.split_quad module
  • schimpy.stacked_dem_fill module
    • ParseType()
    • Usage()
    • bilinear()
    • create_arg_parser()
    • filelist_main()
    • fill_2dm()
    • fill_gr3()
    • main()
    • stacked_dem_fill()
    • test_main()
  • schimpy.station module
  • schimpy.subset_schism_output module
    • create_arg_parser()
    • create_partition()
    • partition_schout()
    • partition_scribeio()
    • records()
    • subset_schism_output()
    • subset_schism_scribeIO_output()
    • write_global_local_maps()
  • schimpy.three_point_linear_norm module
    • ThreePointLinearNorm
      • ThreePointLinearNorm.autoscale()
      • ThreePointLinearNorm.autoscale_None()
      • ThreePointLinearNorm.inverse()
      • ThreePointLinearNorm.scaled()
  • schimpy.trimesh module
  • schimpy.triquadmesh module
  • schimpy.unit_conversions module
  • schimpy.vgrid_opt2 module
    • example()
    • fix_depth()
    • gradient_matrix()
    • hess_base()
    • incr_grad()
    • index_interior()
    • laplace2()
    • mesh_opt()
    • meshessp()
    • meshgrad()
    • meshobj()
    • smooth_heights()
    • targeth2inv()
    • test_gradients()
    • test_vgrid_spacing()
    • triweight()
  • schimpy.write_ts module
    • cdec_header()
    • write_ts()
  • Module contents