PYORPS

Contents:

  • PYORPS - Python for Optimal Routes in Power Systems
    • Overview
    • Features
    • Quick Start
    • Installation
      • Using pip
      • Optional Dependencies
    • How It Works
    • Use Cases
    • Technical Details
      • Search Space Control: Buffering & Masking
      • Neighborhoods: Fine-Grained Connectivity
      • Data Input: Raster & Vector, Local & Remote
      • Cost Assumptions: From Simple to Complex
      • Rasterization: High-Resolution, Multi-Layer, and Overlay
      • Supported Data Types
      • Various Graph Backends & Path-Finding Algorithms
    • Documentation
    • Contributing
    • License
    • Citation
    • Contact
  • API Reference
    • CostAssumptions
      • CostAssumptions.__init__()
      • CostAssumptions.apply_to_geodataframe()
      • CostAssumptions.convert_df_to_cost_dict()
      • CostAssumptions.cost_dict_to_df()
      • CostAssumptions.load()
      • CostAssumptions.to_csv()
      • CostAssumptions.to_excel()
      • CostAssumptions.to_json()
    • GeoDataset
      • GeoDataset.__init__()
      • GeoDataset.crs
      • GeoDataset.data
      • GeoDataset.file_source
      • GeoDataset.load_data()
    • GeoRasterizer
      • GeoRasterizer.__init__()
      • GeoRasterizer.base_data
      • GeoRasterizer.clip_to_area()
      • GeoRasterizer.create_bounds_geodataframe()
      • GeoRasterizer.create_buffer()
      • GeoRasterizer.crs
      • GeoRasterizer.modify_raster_from_dataset()
      • GeoRasterizer.modify_raster_with_geodataframe()
      • GeoRasterizer.rasterize()
      • GeoRasterizer.save_raster()
      • GeoRasterizer.shrink_raster()
    • InMemoryRasterDataset
      • InMemoryRasterDataset.__init__()
      • InMemoryRasterDataset.count
      • InMemoryRasterDataset.crs
      • InMemoryRasterDataset.data
      • InMemoryRasterDataset.dtype
      • InMemoryRasterDataset.file_source
      • InMemoryRasterDataset.load_data()
      • InMemoryRasterDataset.shape
      • InMemoryRasterDataset.transform
    • InMemoryVectorDataset
      • InMemoryVectorDataset.__init__()
      • InMemoryVectorDataset.apply_bbox()
      • InMemoryVectorDataset.apply_mask()
      • InMemoryVectorDataset.bbox
      • InMemoryVectorDataset.correct_crs()
      • InMemoryVectorDataset.crs
      • InMemoryVectorDataset.data
      • InMemoryVectorDataset.file_source
      • InMemoryVectorDataset.load_data()
      • InMemoryVectorDataset.mask
      • InMemoryVectorDataset.post_loading()
    • LocalRasterDataset
      • LocalRasterDataset.__init__()
      • LocalRasterDataset.count
      • LocalRasterDataset.crs
      • LocalRasterDataset.data
      • LocalRasterDataset.dtype
      • LocalRasterDataset.file_source
      • LocalRasterDataset.load_data()
      • LocalRasterDataset.shape
      • LocalRasterDataset.transform
    • LocalVectorDataset
      • LocalVectorDataset.__init__()
      • LocalVectorDataset.apply_bbox()
      • LocalVectorDataset.apply_mask()
      • LocalVectorDataset.bbox
      • LocalVectorDataset.correct_crs()
      • LocalVectorDataset.crs
      • LocalVectorDataset.data
      • LocalVectorDataset.file_source
      • LocalVectorDataset.load_data()
      • LocalVectorDataset.mask
      • LocalVectorDataset.post_loading()
    • Path
      • Path.__eq__()
      • Path.__init__()
      • Path.__repr__()
      • Path.__str__()
      • Path.algorithm
      • Path.euclidean_distance
      • Path.graph_api
      • Path.length_by_category
      • Path.length_by_category_percent
      • Path.neighborhood
      • Path.path_coords
      • Path.path_geometry
      • Path.path_id
      • Path.path_indices
      • Path.runtimes
      • Path.search_space_buffer_m
      • Path.source
      • Path.target
      • Path.to_geodataframe_dict()
      • Path.total_cost
      • Path.total_length
    • PathCollection
      • PathCollection.__eq__()
      • PathCollection.__getitem__()
      • PathCollection.__init__()
      • PathCollection.__iter__()
      • PathCollection.__len__()
      • PathCollection.__repr__()
      • PathCollection.__str__()
      • PathCollection.add()
      • PathCollection.all
      • PathCollection.get()
      • PathCollection.to_geodataframe_records()
    • PathFinder
      • PathFinder.__init__()
      • PathFinder.calculate_path_metrics()
      • PathFinder.create_graph()
      • PathFinder.create_path_geodataframe()
      • PathFinder.create_raster_handler()
      • PathFinder.find_route()
      • PathFinder.get_coords_from_node_indices()
      • PathFinder.get_node_indices_from_coords()
      • PathFinder.get_path()
      • PathFinder.graph_api
      • PathFinder.normalize_coordinates()
      • PathFinder.plot_paths()
      • PathFinder.save_paths()
      • PathFinder.save_raster()
    • RasterDataset
      • RasterDataset.__init__()
      • RasterDataset.count
      • RasterDataset.crs
      • RasterDataset.data
      • RasterDataset.dtype
      • RasterDataset.file_source
      • RasterDataset.load_data()
      • RasterDataset.shape
      • RasterDataset.transform
    • VectorDataset
      • VectorDataset.__init__()
      • VectorDataset.apply_bbox()
      • VectorDataset.apply_mask()
      • VectorDataset.bbox
      • VectorDataset.correct_crs()
      • VectorDataset.crs
      • VectorDataset.data
      • VectorDataset.file_source
      • VectorDataset.load_data()
      • VectorDataset.mask
      • VectorDataset.post_loading()
    • WFSVectorDataset
      • WFSVectorDataset.__init__()
      • WFSVectorDataset.apply_bbox()
      • WFSVectorDataset.apply_mask()
      • WFSVectorDataset.bbox
      • WFSVectorDataset.correct_crs()
      • WFSVectorDataset.crs
      • WFSVectorDataset.data
      • WFSVectorDataset.file_source
      • WFSVectorDataset.load_data()
      • WFSVectorDataset.mask
      • WFSVectorDataset.post_loading()
    • detect_feature_columns()
    • get_zero_cost_assumptions()
    • initialize_geo_dataset()
    • save_empty_cost_assumptions()
  • Contributing to PYORPS
    • Get in Touch!
    • Setting Up Your Development Environment
    • Making Changes
    • Keeping Your Fork Up-to-Date
    • Writing Tests
    • Code Style
    • Contributing Examples or Case Studies
    • Thank You!
PYORPS
  • PYORPS documentation
  • View page source

PYORPS documentation

Welcome to the PYORPS documentation!

Contents:

  • PYORPS - Python for Optimal Routes in Power Systems
    • Overview
    • Features
    • Quick Start
    • Installation
    • How It Works
    • Use Cases
    • Technical Details
    • Documentation
    • Contributing
    • License
    • Citation
    • Contact
  • API Reference
    • CostAssumptions
    • GeoDataset
    • GeoRasterizer
    • InMemoryRasterDataset
    • InMemoryVectorDataset
    • LocalRasterDataset
    • LocalVectorDataset
    • Path
    • PathCollection
    • PathFinder
    • RasterDataset
    • VectorDataset
    • WFSVectorDataset
    • detect_feature_columns()
    • get_zero_cost_assumptions()
    • initialize_geo_dataset()
    • save_empty_cost_assumptions()
  • Contributing to PYORPS
    • Get in Touch!
    • Setting Up Your Development Environment
    • Making Changes
    • Keeping Your Fork Up-to-Date
    • Writing Tests
    • Code Style
    • Contributing Examples or Case Studies
    • Thank You!
Next

© Copyright 2025, Martin Hofmann.

Built with Sphinx using a theme provided by Read the Docs.