Permalink
Browse files

doc updates

  • Loading branch information...
1 parent 2f906a3 commit e87299a366577e8fd59bb79e4cc3e7b3c2830877 @timlinux timlinux committed Mar 13, 2013
@@ -4,12 +4,12 @@ Package::safe
.. toctree::
:maxdepth: 2
- safe/api
safe/defaults
+ safe/api
+ safe/test
+ safe/impact_functions
+ safe/common
safe/storage
safe/engine
- safe/impact_functions
- safe/test
safe/postprocessors
- safe/common
safe/i18n
@@ -4,19 +4,19 @@ Package::safe.common
.. toctree::
:maxdepth: 2
+ common/interpolation1d
common/geodesy
- common/dynamic_translations
+ common/numerics
common/interpolation2d
- common/utilities
- common/polygon
- common/interpolation1d
+ common/test_tables
common/testing
- common/test_numerics
+ common/version
common/test_polygon
- common/test_interpolate
+ common/test_numerics
+ common/polygon
+ common/tables
+ common/dynamic_translations
common/exceptions
- common/numerics
+ common/utilities
common/test_geodesy
- common/tables
- common/test_tables
- common/version
+ common/test_interpolate
@@ -4,8 +4,8 @@ Package::safe.engine
.. toctree::
:maxdepth: 2
- engine/core
engine/interpolation
- engine/utilities
engine/test_engine
+ engine/core
+ engine/utilities
engine/impact_functions_for_testing
@@ -4,18 +4,18 @@ Package::safe.engine.impact_functions_for_testing
.. toctree::
:maxdepth: 2
- impact_functions_for_testing/unspecific_building_impact_model
- impact_functions_for_testing/BNPB_earthquake_guidelines
- impact_functions_for_testing/flood_road_impact
- impact_functions_for_testing/categorised_hazard_population
- impact_functions_for_testing/allen_fatality_model
- impact_functions_for_testing/itb_fatality_model_org
impact_functions_for_testing/padang_building_impact_model
- impact_functions_for_testing/general_ashload_impact
impact_functions_for_testing/earthquake_impact_on_women
- impact_functions_for_testing/NEXIS_building_impact_model
- impact_functions_for_testing/HKV_flood_study
- impact_functions_for_testing/empirical_fatality_model
+ impact_functions_for_testing/general_ashload_impact
impact_functions_for_testing/categorised_hazard_building_impact
+ impact_functions_for_testing/empirical_fatality_model
impact_functions_for_testing/error_raising_functions
impact_functions_for_testing/itb_fatality_model_configurable
+ impact_functions_for_testing/HKV_flood_study
+ impact_functions_for_testing/NEXIS_building_impact_model
+ impact_functions_for_testing/unspecific_building_impact_model
+ impact_functions_for_testing/BNPB_earthquake_guidelines
+ impact_functions_for_testing/flood_road_impact
+ impact_functions_for_testing/allen_fatality_model
+ impact_functions_for_testing/categorised_hazard_population
+ impact_functions_for_testing/itb_fatality_model_org
@@ -4,16 +4,16 @@ Package::safe.impact_functions
.. toctree::
:maxdepth: 2
+ impact_functions/styles
+ impact_functions/test_plugins
+ impact_functions/test_mappings
impact_functions/core
impact_functions/test_plugin_core
impact_functions/mappings
- impact_functions/test_mappings
- impact_functions/utilities
- impact_functions/test_plugins
- impact_functions/styles
impact_functions/test_real_impact_functions
- impact_functions/inundation
+ impact_functions/utilities
+ impact_functions/volcanic
+ impact_functions/tephra
impact_functions/generic
impact_functions/earthquake
- impact_functions/tephra
- impact_functions/volcanic
+ impact_functions/inundation
@@ -5,6 +5,6 @@ Package::safe.impact_functions.earthquake
:maxdepth: 2
earthquake/earthquake_building_impact
+ earthquake/itb_building_impact_model
earthquake/itb_earthquake_fatality_model
earthquake/pager_earthquake_fatality_model
- earthquake/itb_building_impact_model
@@ -4,7 +4,7 @@ Package::safe.impact_functions.inundation
.. toctree::
:maxdepth: 2
- inundation/flood_road_impact_experimental
- inundation/flood_OSM_building_impact
inundation/flood_population_evacuation
inundation/flood_population_evacuation_polygon_hazard
+ inundation/flood_OSM_building_impact
+ inundation/flood_road_impact_experimental
@@ -4,10 +4,10 @@ Package::safe.postprocessors
.. toctree::
:maxdepth: 2
- postprocessors/aggregation_postprocessor
postprocessors/abstract_postprocessor
+ postprocessors/aggregation_postprocessor
postprocessors/age_postprocessor
- postprocessors/building_type_postprocessor
+ postprocessors/aggregation_categorical_postprocessor
postprocessors/gender_postprocessor
+ postprocessors/building_type_postprocessor
postprocessors/postprocessor_factory
- postprocessors/aggregation_categorical_postprocessor
@@ -4,16 +4,16 @@ Package::safe.storage
.. toctree::
:maxdepth: 2
- storage/core
- storage/test_clipping
storage/layer
storage/raster
- storage/projection
- storage/test_io
- storage/geometry
- storage/utilities
- storage/utilities_test
- storage/clipping
storage/test_utilities
+ storage/utilities_test
+ storage/core
+ storage/test_clipping
+ storage/geometry
+ storage/projection
storage/test_vector
+ storage/clipping
storage/vector
+ storage/utilities
+ storage/test_io
@@ -4,31 +4,31 @@ Package::safe_qgis
.. toctree::
:maxdepth: 2
- safe_qgis/dock_base
- safe_qgis/html_renderer
- safe_qgis/qgis_interface
- safe_qgis/keywords_dialog_base
- safe_qgis/minimum_needs_base
+ safe_qgis/impact_calculator
+ safe_qgis/impact_calculator_thread
+ safe_qgis/map
safe_qgis/dock
+ safe_qgis/map_legend
safe_qgis/resources_rc
- safe_qgis/impact_functions_doc_base
- safe_qgis/options_dialog
+ safe_qgis/utilities_test
safe_qgis/plugin
safe_qgis/safe_interface
+ safe_qgis/clipper
safe_qgis/keywords_dialog
- safe_qgis/map
- safe_qgis/utilities
+ safe_qgis/dock_base
+ safe_qgis/function_options_dialog_base
safe_qgis/function_options_dialog
+ safe_qgis/impact_functions_doc
safe_qgis/resources
- safe_qgis/impact_calculator
- safe_qgis/help
- safe_qgis/utilities_test
- safe_qgis/clipper
+ safe_qgis/options_dialog
safe_qgis/keyword_io
- safe_qgis/map_legend
+ safe_qgis/options_dialog_base
safe_qgis/minimum_needs
+ safe_qgis/minimum_needs_base
+ safe_qgis/keywords_dialog_base
+ safe_qgis/impact_functions_doc_base
+ safe_qgis/qgis_interface
safe_qgis/exceptions
- safe_qgis/options_dialog_base
- safe_qgis/function_options_dialog_base
- safe_qgis/impact_calculator_thread
- safe_qgis/impact_functions_doc
+ safe_qgis/help
+ safe_qgis/utilities
+ safe_qgis/html_renderer
@@ -4,20 +4,20 @@ Package::safe_qgis_tests
.. toctree::
:maxdepth: 2
+ safe_qgis_tests/test_dock
+ safe_qgis_tests/test_map_legend
+ safe_qgis_tests/test_function_options_dialog
safe_qgis_tests/test_init
- safe_qgis_tests/test_impact_functions_doc
- safe_qgis_tests/test_html_renderer
safe_qgis_tests/test_impact_calculator
- safe_qgis_tests/test_plugin
- safe_qgis_tests/test_map_legend
+ safe_qgis_tests/test_utilities
+ safe_qgis_tests/test_help
safe_qgis_tests/test_keyword_io
- safe_qgis_tests/test_safe_translations
+ safe_qgis_tests/test_html_renderer
+ safe_qgis_tests/test_map
+ safe_qgis_tests/test_plugin
safe_qgis_tests/test_safe_interface
+ safe_qgis_tests/test_clipper
safe_qgis_tests/test_keywords_dialog
- safe_qgis_tests/test_utilities
- safe_qgis_tests/test_dock
- safe_qgis_tests/test_map
safe_qgis_tests/test_qgis_environment
- safe_qgis_tests/test_help
- safe_qgis_tests/test_function_options_dialog
- safe_qgis_tests/test_clipper
+ safe_qgis_tests/test_impact_functions_doc
+ safe_qgis_tests/test_safe_translations
@@ -15,7 +15,7 @@ Details
No documentation found
-Doc String
+Docstring
----------
Earthquake impact on building data
@@ -39,7 +39,7 @@ Details
The inundation status is calculated for each building (using the centroid if it is a polygon) based on the hazard levels provided. if the hazard is given as a raster a threshold of 1 meter is used. This is configurable through the InaSAFE interface. If the hazard is given as a vector polygon layer buildings are considered to be impacted depending on the value of hazard attributes (in order) "affected" or "FLOODPRONE": If a building is in a region that has attribute "affected" set to True (or 1) it is impacted. If attribute "affected" does not exist but "FLOODPRONE" does, then the building is considered impacted if "FLOODPRONE" is "yes". If neither "affected" nor "FLOODPRONE" is available, a building will be impacted if it belongs to any polygon. The latter behaviour is implemented through the attribute "inapolygon" which is automatically assigned.
-Doc String
+Docstring
----------
Inundation impact on building data
@@ -39,7 +39,7 @@ Details
The population subject to inundation exceeding a threshold (default 1m) is calculated and returned as a raster layer.In addition the total number and the required needs in terms of the BNPB (Perka 7) are reported. The threshold can be changed and even contain multiple numbers in which case evacuation and needs are calculated using the largest number with population breakdowns provided for the smaller numbers. The population raster is resampled to the resolution of the hazard raster and is rescaled so that the resampled population counts reflect estimates of population count per resampled cell. The resulting impact layer has the same resolution and reflects population count per cell which are affected by inundation.
-Doc String
+Docstring
----------
Impact function for flood evacuation
@@ -36,7 +36,7 @@ Details
The population subject to inundation is determined whether inan area which affected or not. You can also set an evacuationpercentage to calculate how many percent of the total populationaffected to be evacuated. This number will be used to estimateneeds based on BNPB Perka 7/2008 minimum bantuan.
-Doc String
+Docstring
----------
Impact function for vector flood evacuation
@@ -47,7 +47,7 @@ Algorithm:
In this study, the same functional form as Allen (2009) is adopted o express fatality rate as a function of intensity (see Eq. 10 in the report). The Matlab built-in function (fminsearch) for Nelder-Mead algorithm was used to estimate the model parameters. The objective function (L2G norm) that is minimized during the optimisation is the same as the one used by Jaiswal et al. (2010).
The coefficients used in the indonesian model are x=0.62275231, y=8.03314466, zeta=2.15
-Doc String
+Docstring
----------
Indonesian Earthquake Fatality Model
@@ -33,7 +33,7 @@ Details
No documentation found
-Doc String
+Docstring
----------
@@ -36,7 +36,7 @@ Details
No documentation found
-Doc String
+Docstring
----------
Risk plugin for volcano evacuation
@@ -36,7 +36,7 @@ Details
No documentation found
-Doc String
+Docstring
----------
Impact function for volcano hazard zones impact on population
@@ -7,9 +7,9 @@ This document explains the purpose of impact functions and lists the different a
.. toctree::
:maxdepth: 2
- impact_function_docs/PAGFatalityFunction
- impact_function_docs/EarthquakeBuildingImpactFunction
impact_function_docs/FloodEvacuationFunctionVectorHazard
+ impact_function_docs/EarthquakeBuildingImpactFunction
+ impact_function_docs/PAGFatalityFunction
impact_function_docs/FloodEvacuationFunction
impact_function_docs/FloodBuildingImpactFunction
impact_function_docs/ITBFatalityFunction

0 comments on commit e87299a

Please sign in to comment.