Skip to content

[DOC] Format docstrings according to numpydoc #352

@AlexanderJuestel

Description

@AlexanderJuestel

vector.py

  • 84d01f7 - extract_xy_points
  • 34ddc0f - extract_xy_linestring
  • ff63448 - 'extract_xy_linestrings
  • 07ce0f4 - extract_xy
  • 2e8b180 - extract_xyz_points
  • 3f3b96f - extract_xyz_linestrings
  • 58c82bf - extract_xyz_polygons
  • 2df1ec3 - extract_xyz_rasterio
  • c5def25 - extract_xyz_array
  • c5def25 - extract_xyz
  • 29e8199 - explode_linestring
  • 606a031 - explode_linestring_to_elements
  • 085716b - explode_multilinestring
  • cb10bae - explode_multilinestrings
  • 538e538 - explode_polygon
  • e5713f3 - explode_polygons
  • e73687f - explode_geometry_collection
  • 75e4a11 - explode_geometry_collections
  • afedf6b - creating_linestring_from_xyz_points
  • 53cbfbe - creating_linestrings_from_xyz_points
  • 021a2b1 - create_linestrings_from_contours
  • 1ff5556 - interpolate_raster
  • 70296a0 - clip_by_bbox
  • 4235824 - clip_by_polygon
  • 86bcbc2 - create_buffer
  • 805a095 - create_unified_buffer
  • 832c437 - subtract_geom_objects
  • 4f984d9 - remove_object_within_buffer
  • c6e403b - remove_objects_within_buffer
  • 2d171e4 -remove_interfaces_within_fault_buffers
  • 01ddde2 - calculate_angle
  • calculate_strike_direction_straight_linestring
  • calculate_strike_direction_bent_linestring
  • calculate_dipping_angle_linestring
  • calculate_dipping_angles_linestrings
  • calculate_coordinates_for_point_on_cross_section
  • calculate_coordinates_for_linestring_on_cross_sections
  • calculate_coordinates_for_linestrings_on_cross_sections
  • extract_interfaces_coordinates_from_cross_section
  • extract_xyz_from_cross_sections
  • calculate_midpoint_linestring
  • calculate_midpoints_linestrings
  • calculate_orientation_from_cross_section
  • calculate_orientation_from_bent_cross_section
  • calculate_orientations_from_cross_section
  • extract_orientations_from_cross_sections
  • calculate_orientation_for_three_point_problem
  • intersect_polygon_polygon
  • intersect_polygon_polygons
  • intersect_polygons_polygons
  • extract_xy_from_polygon_intersections
  • calculate_azimuth
  • create_linestring_from_points
  • create_linestring_gdf
  • extract_orientations_from_map
  • calculate_distance_linestrings
  • calculate_orientations_from_strike_lines
  • load_gpx
  • load_gpx_as_dict
  • load_gpx_as_geometry
  • load_gpx_as_gdf
  • sort_by_stratigraphy
  • create_bbox
  • set_dtype
  • create_polygons_from_faces
  • unify_polygons
  • unify_linestrings
  • create_hexagon
  • create_hexagon_grid
  • create_voronoi_polygons

raster.py

  • calculate_aspect
  • calculate_default_transform
  • calculate_difference
  • calculate_hillshades
  • calculate_slope
  • clip_by_bbox
  • clip_by_polygon
  • create_filepaths
  • create_src_list
  • extract_contour_lines_from_raster
  • merge_tiles
  • read_asc
  • read_msh
  • read_ts
  • read_zmap
  • reproject
  • reproject_raster
  • resize_by_array
  • resize_raster
  • sample_from_array
  • sample_from_rasterio
  • sample_interfaces
  • sample_orientations
  • sample_randomly
  • save_as_tiff

visualization.py

  • add_row_to_boreholes
  • calculate_vector
  • clip_seismic_data
  • convert_to_rgb
  • create_borehole_labels
  • create_borehole_tube
  • create_borehole_tubes
  • create_boreholes_3d
  • create_delaunay_mesh_from_gdf
  • create_dem_3d
  • create_depth_map
  • create_depth_maps_from_gempy
  • create_deviated_borehole_df
  • create_deviated_boreholes_3d
  • create_lines_3d_linestrings
  • create_lines_3d_polydata
  • create_lines_from_points
  • create_mesh_from_cross_section
  • create_meshes_from_cross_sections
  • create_meshes_hypocenters
  • create_points_3d
  • create_polydata_from_dxf
  • create_polydata_from_msh
  • create_polydata_from_ts
  • create_structured_grid_from_asc
  • create_structured_grid_from_zmap
  • create_temperature_map
  • create_thickness_maps
  • drape_array_over_dem
  • extract_xy
  • extract_xyz
  • get_batlow_cmap
  • get_color_lot
  • get_mesh_geological_map
  • get_petrel_cmap
  • get_points_along_spline
  • get_seismic_cmap
  • group_borehole_dataframe
  • plane_through_hypocenters
  • plot_data
  • plot_orientations
  • polyline_from_points
  • read_raster
  • resample_between_well_deviation_points
  • sample_from_rasterio
  • seismic_to_array
  • seismic_to_mesh
  • set_extent
  • show_well_log_along_well

web.py

utils.py

  • assign_properties
  • build_style_dict
  • calculate_lines
  • calculate_number_of_isopoints
  • convert_location_dict_to_gdf
  • convert_to_gempy_df
  • convert_to_petrel_points_with_attributes
  • create_polygon_from_location
  • create_surface_color_dict
  • create_virtual_profile
  • create_zmap_grid
  • extract_zmap_data
  • get_location_coordinate
  • get_locations
  • get_nearest_neighbor
  • getfeatures
  • interpolate_strike_lines
  • load_surface_colors
  • parse_categorized_qml
  • ray_trace_multiple_surfaces
  • ray_trace_one_surface
  • read_csv_as_gdf
  • rotate_gempy_input_data
  • save_zmap_grid
  • set_extent
  • set_resolution
  • show_number_of_data_points
  • to_section_dict
  • transform_location_coordinate

visualization.y

download_gemgis_data

misc.py

  • get_meta_data
  • get_meta_data_df
  • get_stratigraphic_data
  • get_stratigraphic_data_df
  • load_formations
  • load_pdf
  • load_symbols

gemgis.py

  • build_style_dict
  • calculate_aspect
  • calculate_hillshades
  • calculate_slope
  • create_surface_color_dict
  • extract_xy
  • extract_xyz
  • parse_categorized_qml
  • calculate_dip_and_azimuth_from_mesh
  • clip_fault_of_gempy_model
  • create_attributes
  • create_plane_from_interface_and_orientation_dfs
  • create_subelement
  • create_symbol
  • crop_block_to_topography
  • extract_borehole
  • extract_lithologies
  • extract_orientations_from_mesh
  • save_model
  • save_qgis_qml_file
  • translate_clipping_plane

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions