diff --git a/documentation/gis.rst b/documentation/gis.rst index 6a4428e84..3f3c765e5 100644 --- a/documentation/gis.rst +++ b/documentation/gis.rst @@ -119,13 +119,13 @@ For example, the junctions GeoDataFrame contains the following information: :skipif: gpd is None >>> print(wn_gis.junctions.head()) - elevation initial_quality geometry - name - 10 216.408 5.000e-04 POINT (20.00000 70.00000) - 11 216.408 5.000e-04 POINT (30.00000 70.00000) - 12 213.360 5.000e-04 POINT (50.00000 70.00000) - 13 211.836 5.000e-04 POINT (70.00000 70.00000) - 21 213.360 5.000e-04 POINT (30.00000 40.00000) + base_demand demand_pattern elevation initial_quality geometry + name + 10 0.000 1 216.408 5.000e-04 POINT (20.00000 70.00000) + 11 0.009 1 216.408 5.000e-04 POINT (30.00000 70.00000) + 12 0.009 1 213.360 5.000e-04 POINT (50.00000 70.00000) + 13 0.006 1 211.836 5.000e-04 POINT (70.00000 70.00000) + 21 0.009 1 213.360 5.000e-04 POINT (30.00000 40.00000) Each GeoDataFrame contains attributes and geometry: @@ -341,23 +341,23 @@ and then translates the GeoDataFrames coordinates to EPSG:3857. >>> wn_gis = wntr.network.to_gis(wn, crs='EPSG:4326') >>> print(wn_gis.junctions.head()) - elevation initial_quality geometry - name - 10 216.408 5.000e-04 POINT (20.00000 70.00000) - 11 216.408 5.000e-04 POINT (30.00000 70.00000) - 12 213.360 5.000e-04 POINT (50.00000 70.00000) - 13 211.836 5.000e-04 POINT (70.00000 70.00000) - 21 213.360 5.000e-04 POINT (30.00000 40.00000) + base_demand demand_pattern elevation initial_quality geometry + name + 10 0.000 1 216.408 5.000e-04 POINT (20.00000 70.00000) + 11 0.009 1 216.408 5.000e-04 POINT (30.00000 70.00000) + 12 0.009 1 213.360 5.000e-04 POINT (50.00000 70.00000) + 13 0.006 1 211.836 5.000e-04 POINT (70.00000 70.00000) + 21 0.009 1 213.360 5.000e-04 POINT (30.00000 40.00000) >>> wn_gis.to_crs('EPSG:3857') >>> print(wn_gis.junctions.head()) - elevation initial_quality geometry - name - 10 216.408 5.000e-04 POINT (2226389.816 11068715.659) - 11 216.408 5.000e-04 POINT (3339584.724 11068715.659) - 12 213.360 5.000e-04 POINT (5565974.540 11068715.659) - 13 211.836 5.000e-04 POINT (7792364.356 11068715.659) - 21 213.360 5.000e-04 POINT (3339584.724 4865942.280) + base_demand demand_pattern elevation initial_quality geometry + name + 10 0.000 1 216.408 5.000e-04 POINT (2226389.816 11068715.659) + 11 0.009 1 216.408 5.000e-04 POINT (3339584.724 11068715.659) + 12 0.009 1 213.360 5.000e-04 POINT (5565974.540 11068715.659) + 13 0.006 1 211.836 5.000e-04 POINT (7792364.356 11068715.659) + 21 0.009 1 213.360 5.000e-04 POINT (3339584.724 4865942.280) Snap point geometries to the nearest point or line ---------------------------------------------------- diff --git a/documentation/model_io.rst b/documentation/model_io.rst index bcd5b7636..22efe05d4 100644 --- a/documentation/model_io.rst +++ b/documentation/model_io.rst @@ -217,7 +217,7 @@ The following example returns valid GeoJSON column names for junctions. >>> geojson_column_names = wntr.network.io.valid_gis_names() >>> print(geojson_column_names['junctions']) - ['name', 'elevation', 'geometry', 'emitter_coefficient', 'initial_quality', 'minimum_pressure', 'required_pressure', 'pressure_exponent', 'tag'] + ['name', 'elevation', 'geometry', 'base_demand', 'demand_pattern', 'demand_category', 'emitter_coefficient', 'initial_quality', 'minimum_pressure', 'required_pressure', 'pressure_exponent', 'tag'] A minimal list of required column names can also be obtained by setting ``complete_list`` to False. Column names that are optional (i.e., ``initial_quality``) and not included in the GeoJSON file are @@ -314,7 +314,7 @@ To use Esri Shapefiles in WNTR, several formatting requirements are enforced: >>> shapefile_field_names = wntr.network.io.valid_gis_names(truncate_names=10) >>> print(shapefile_field_names['junctions']) - ['name', 'elevation', 'geometry', 'emitter_co', 'initial_qu', 'minimum_pr', 'required_p', 'pressure_e', 'tag'] + ['name', 'elevation', 'geometry', 'base_deman', 'demand_pat', 'demand_cat', 'emitter_co', 'initial_qu', 'minimum_pr', 'required_p', 'pressure_e', 'tag'] A minimal list of required field names can also be obtained by setting ``complete_list`` to False. Field names that are optional (i.e., ``initial_quality``) and not included in the Shapefile are defined using default values.