Try GitHub Pages (fix jkreklow#10)

katrinleinweber · Nov 7, 2018 · 2c64ebd · 2c64ebd
1 parent a8ad94b
commit 2c64ebd
Show file tree

Hide file tree

Showing 316 changed files with 51,010 additions and 3 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Makefile b/docs/Makefile
@@ -5,7 +5,7 @@
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = radproc
-SOURCEDIR     = .
+SOURCEDIR     = source
 BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
@@ -18,4 +18,4 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
+	cp -R $(BUILDDIR)/* .  
diff --git a/docs/_images/Workflow.png b/docs/_images/Workflow.png
diff --git a/docs/_sources/arcgis.rst.txt b/docs/_sources/arcgis.rst.txt
@@ -0,0 +1 @@
+.. automodule:: radproc.arcgis
diff --git a/docs/_sources/core.rst.txt b/docs/_sources/core.rst.txt
@@ -0,0 +1 @@
+.. automodule:: radproc.core
diff --git a/docs/_sources/dwd_gauge.rst.txt b/docs/_sources/dwd_gauge.rst.txt
@@ -0,0 +1 @@
+.. automodule:: radproc.dwd_gauge
diff --git a/docs/_sources/generated/radproc.arcgis.attribute_table_to_df.rst.txt b/docs/_sources/generated/radproc.arcgis.attribute_table_to_df.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.attribute\_table\_to\_df
+=========================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: attribute_table_to_df
diff --git a/docs/_sources/generated/radproc.arcgis.clip_idraster.rst.txt b/docs/_sources/generated/radproc.arcgis.clip_idraster.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.clip\_idraster
+===============================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: clip_idraster
diff --git a/docs/_sources/generated/radproc.arcgis.create_idarray.rst.txt b/docs/_sources/generated/radproc.arcgis.create_idarray.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.create\_idarray
+================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: create_idarray
diff --git a/docs/_sources/generated/radproc.arcgis.create_idraster_germany.rst.txt b/docs/_sources/generated/radproc.arcgis.create_idraster_germany.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.create\_idraster\_germany
+==========================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: create_idraster_germany
diff --git a/docs/_sources/generated/radproc.arcgis.export_dfrows_to_gdb.rst.txt b/docs/_sources/generated/radproc.arcgis.export_dfrows_to_gdb.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.export\_dfrows\_to\_gdb
+========================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: export_dfrows_to_gdb
diff --git a/docs/_sources/generated/radproc.arcgis.export_to_raster.rst.txt b/docs/_sources/generated/radproc.arcgis.export_to_raster.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.export\_to\_raster
+===================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: export_to_raster
diff --git a/docs/_sources/generated/radproc.arcgis.idTable_nineGrid.rst.txt b/docs/_sources/generated/radproc.arcgis.idTable_nineGrid.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.idTable\_nineGrid
+==================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: idTable_nineGrid
diff --git a/docs/_sources/generated/radproc.arcgis.idTable_to_valueTable.rst.txt b/docs/_sources/generated/radproc.arcgis.idTable_to_valueTable.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.idTable\_to\_valueTable
+========================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: idTable_to_valueTable
diff --git a/docs/_sources/generated/radproc.arcgis.import_idarray_from_raster.rst.txt b/docs/_sources/generated/radproc.arcgis.import_idarray_from_raster.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.import\_idarray\_from\_raster
+==============================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: import_idarray_from_raster
diff --git a/docs/_sources/generated/radproc.arcgis.join_df_columns_to_attribute_table.rst.txt b/docs/_sources/generated/radproc.arcgis.join_df_columns_to_attribute_table.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.join\_df\_columns\_to\_attribute\_table
+========================================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: join_df_columns_to_attribute_table
diff --git a/docs/_sources/generated/radproc.arcgis.raster_to_array.rst.txt b/docs/_sources/generated/radproc.arcgis.raster_to_array.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.raster\_to\_array
+==================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: raster_to_array
diff --git a/docs/_sources/generated/radproc.arcgis.rastervalues_to_points.rst.txt b/docs/_sources/generated/radproc.arcgis.rastervalues_to_points.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.rastervalues\_to\_points
+=========================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: rastervalues_to_points
diff --git a/docs/_sources/generated/radproc.arcgis.valueTable_nineGrid.rst.txt b/docs/_sources/generated/radproc.arcgis.valueTable_nineGrid.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.valueTable\_nineGrid
+=====================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: valueTable_nineGrid
diff --git a/docs/_sources/generated/radproc.arcgis.zonalstatistics.rst.txt b/docs/_sources/generated/radproc.arcgis.zonalstatistics.rst.txt
@@ -0,0 +1,6 @@
+radproc\.arcgis\.zonalstatistics
+================================
+
+.. currentmodule:: radproc.arcgis
+
+.. autofunction:: zonalstatistics
diff --git a/docs/_sources/generated/radproc.core.coordinates_degree_to_stereographic.rst.txt b/docs/_sources/generated/radproc.core.coordinates_degree_to_stereographic.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.coordinates\_degree\_to\_stereographic
+=====================================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: coordinates_degree_to_stereographic
diff --git a/docs/_sources/generated/radproc.core.hdf5_to_days.rst.txt b/docs/_sources/generated/radproc.core.hdf5_to_days.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.hdf5\_to\_days
+=============================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: hdf5_to_days
diff --git a/docs/_sources/generated/radproc.core.hdf5_to_hours.rst.txt b/docs/_sources/generated/radproc.core.hdf5_to_hours.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.hdf5\_to\_hours
+==============================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: hdf5_to_hours
diff --git a/docs/_sources/generated/radproc.core.hdf5_to_hydrologicalSeasons.rst.txt b/docs/_sources/generated/radproc.core.hdf5_to_hydrologicalSeasons.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.hdf5\_to\_hydrologicalSeasons
+============================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: hdf5_to_hydrologicalSeasons
diff --git a/docs/_sources/generated/radproc.core.hdf5_to_months.rst.txt b/docs/_sources/generated/radproc.core.hdf5_to_months.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.hdf5\_to\_months
+===============================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: hdf5_to_months
diff --git a/docs/_sources/generated/radproc.core.hdf5_to_years.rst.txt b/docs/_sources/generated/radproc.core.hdf5_to_years.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.hdf5\_to\_years
+==============================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: hdf5_to_years
diff --git a/docs/_sources/generated/radproc.core.import_idarray_from_txt.rst.txt b/docs/_sources/generated/radproc.core.import_idarray_from_txt.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.import\_idarray\_from\_txt
+=========================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: import_idarray_from_txt
diff --git a/docs/_sources/generated/radproc.core.load_month.rst.txt b/docs/_sources/generated/radproc.core.load_month.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.load\_month
+==========================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: load_month
diff --git a/docs/_sources/generated/radproc.core.load_months_from_hdf5.rst.txt b/docs/_sources/generated/radproc.core.load_months_from_hdf5.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.load\_months\_from\_hdf5
+=======================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: load_months_from_hdf5
diff --git a/docs/_sources/generated/radproc.core.load_years_and_resample.rst.txt b/docs/_sources/generated/radproc.core.load_years_and_resample.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.load\_years\_and\_resample
+=========================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: load_years_and_resample
diff --git a/docs/_sources/generated/radproc.core.save_idarray_to_txt.rst.txt b/docs/_sources/generated/radproc.core.save_idarray_to_txt.rst.txt
@@ -0,0 +1,6 @@
+radproc\.core\.save\_idarray\_to\_txt
+=====================================
+
+.. currentmodule:: radproc.core
+
+.. autofunction:: save_idarray_to_txt
diff --git a/docs/_sources/generated/radproc.dwd_gauge.dwd_gauges_to_hdf5.rst.txt b/docs/_sources/generated/radproc.dwd_gauge.dwd_gauges_to_hdf5.rst.txt
@@ -0,0 +1,6 @@
+radproc\.dwd\_gauge\.dwd\_gauges\_to\_hdf5
+==========================================
+
+.. currentmodule:: radproc.dwd_gauge
+
+.. autofunction:: dwd_gauges_to_hdf5
diff --git a/docs/_sources/generated/radproc.dwd_gauge.stationfile_to_df.rst.txt b/docs/_sources/generated/radproc.dwd_gauge.stationfile_to_df.rst.txt
@@ -0,0 +1,6 @@
+radproc\.dwd\_gauge\.stationfile\_to\_df
+========================================
+
+.. currentmodule:: radproc.dwd_gauge
+
+.. autofunction:: stationfile_to_df
diff --git a/docs/_sources/generated/radproc.dwd_gauge.summarize_metadata_files.rst.txt b/docs/_sources/generated/radproc.dwd_gauge.summarize_metadata_files.rst.txt
@@ -0,0 +1,6 @@
+radproc\.dwd\_gauge\.summarize\_metadata\_files
+===============================================
+
+.. currentmodule:: radproc.dwd_gauge
+
+.. autofunction:: summarize_metadata_files
diff --git a/docs/_sources/generated/radproc.heavyrain.count_heavy_rainfall_intervals.rst.txt b/docs/_sources/generated/radproc.heavyrain.count_heavy_rainfall_intervals.rst.txt
@@ -0,0 +1,6 @@
+radproc\.heavyrain\.count\_heavy\_rainfall\_intervals
+=====================================================
+
+.. currentmodule:: radproc.heavyrain
+
+.. autofunction:: count_heavy_rainfall_intervals
diff --git a/docs/_sources/generated/radproc.heavyrain.find_heavy_rainfalls.rst.txt b/docs/_sources/generated/radproc.heavyrain.find_heavy_rainfalls.rst.txt
@@ -0,0 +1,6 @@
+radproc\.heavyrain\.find\_heavy\_rainfalls
+==========================================
+
+.. currentmodule:: radproc.heavyrain
+
+.. autofunction:: find_heavy_rainfalls
diff --git a/..._sources/generated/radproc.raw.create_idraster_and_process_radolan_data.rst.txt b/..._sources/generated/radproc.raw.create_idraster_and_process_radolan_data.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.create\_idraster\_and\_process\_radolan\_data
+===========================================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: create_idraster_and_process_radolan_data
diff --git a/docs/_sources/generated/radproc.raw.process_radolan_data.rst.txt b/docs/_sources/generated/radproc.raw.process_radolan_data.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.process\_radolan\_data
+====================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: process_radolan_data
diff --git a/docs/_sources/generated/radproc.raw.radolan_binaries_to_dataframe.rst.txt b/docs/_sources/generated/radproc.raw.radolan_binaries_to_dataframe.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.radolan\_binaries\_to\_dataframe
+==============================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: radolan_binaries_to_dataframe
diff --git a/docs/_sources/generated/radproc.raw.radolan_binaries_to_hdf5.rst.txt b/docs/_sources/generated/radproc.raw.radolan_binaries_to_hdf5.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.radolan\_binaries\_to\_hdf5
+=========================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: radolan_binaries_to_hdf5
diff --git a/docs/_sources/generated/radproc.raw.unzip_RW_binaries.rst.txt b/docs/_sources/generated/radproc.raw.unzip_RW_binaries.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.unzip\_RW\_binaries
+=================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: unzip_RW_binaries
diff --git a/docs/_sources/generated/radproc.raw.unzip_YW_binaries.rst.txt b/docs/_sources/generated/radproc.raw.unzip_YW_binaries.rst.txt
@@ -0,0 +1,6 @@
+radproc\.raw\.unzip\_YW\_binaries
+=================================
+
+.. currentmodule:: radproc.raw
+
+.. autofunction:: unzip_YW_binaries
diff --git a/docs/_sources/generated/radproc.wradlib_io.read_RADOLAN_composite.rst.txt b/docs/_sources/generated/radproc.wradlib_io.read_RADOLAN_composite.rst.txt
@@ -0,0 +1,6 @@
+radproc\.wradlib\_io\.read\_RADOLAN\_composite
+==============================================
+
+.. currentmodule:: radproc.wradlib_io
+
+.. autofunction:: read_RADOLAN_composite
diff --git a/docs/_sources/gettingstarted.rst.txt b/docs/_sources/gettingstarted.rst.txt
@@ -0,0 +1,68 @@
+.. _ref-getting-started:
+
+=================
+ Getting Started
+=================
+
+.. _ref-requirements:
+
+System requirements
+~~~~~~~~~~~~~~~~~~~
+
+To be able to use all features offered by radproc, you need...
+
+* a 64-Bit operating system (32-Bit systems can not allocate more than 3 GB memory, which is not sufficient for radar data processing)
+* Python version 2.7 (64-Bit). It is strongly recommended to use the Anaconda distribution since this already includes all needed scientific site-packages.
+* ArcMap version 10.4 or newer
+* ArcGIS 64-Bit background processing
+* for processing of RADOLAN data in 5-minute resolution at least 16 GB RAM are recommended
+
+.. _ref-installation:
+
+Installation
+~~~~~~~~~~~~
+First, install ArcMap for Desktop and its extension 64-Bit background processing.
+
+Next, download and install the latest Anaconda distribution from https://www.anaconda.com/download/ (Windows, 64-Bit, Python version 2.7).
+
+All radproc versions are hosted at the Python Package Index (PyPI). Thus, they can be directly downloaded and installed using pip.
+
+To install radproc using Anaconda and pip...
+
+1. Open the Windows terminal by typing CMD into the Windows search (Administrator rights may be necessary!).
+2. Type::
+
+	pip install radproc
+	
+   Now radproc is automatically downloaded from PyPI and installed into your Anaconda root environment.
+   You can check by opening Spyder or Jupyter Notebook and entering::
+
+	import radproc
+	
+   Alternative installation procedure:
+   
+   radproc is also available as wheel file for Python version 2.7 on Windows operating systems (64-Bit only!).
+   You can download the radproc wheel (radproc-0.1.x-py2-none-any.whl) of any version from the GitHub repository at https://github.com/jkreklow/radproc/tree/0.1.3/dist
+   To install the wheel file type::
+	
+	pip install C:\path\to\wheelfile\radproc_wheel.whl
+	
+
+To enable your Anaconda distribution to "see" the arcpy package from your separate ArcGIS Python installation,
+you need to **copy the Path file DTBGGP64.pth** which is usually located at *C:\\Python27\\ArcGISx6410.4\\Lib\\site-packages*
+into the corresponding site-packages folder of your Anaconda distribution, e.g. *C:\\ProgramData\\Anaconda2\\Lib\\site-packages*
+
+To check if arcpy is now visible for Anaconda, import arcpy to Spyder or Jupyter Notebook::
+
+	import arcpy
+
+
+.. _ref-filesystem:
+
+File system description
+~~~~~~~~~~~~~~~~~~~~~~~
+.. image:: images/Workflow_english.png
+	:height: 375
+	:width: 675
+
+File system and processing workflow used by radproc.
diff --git a/docs/_sources/heavyrain.rst.txt b/docs/_sources/heavyrain.rst.txt
@@ -0,0 +1 @@
+.. automodule:: radproc.heavyrain