Added sphinx documentation skeleton

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/conf.py

@@ -0,0 +1,11 @@
+project = 'TomorrowCities'
+copyright = '2023, TomorrowCities'
+author = 'H. Kaya'
+
+extensions = []
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/gui.rst

@@ -0,0 +1,16 @@
+:: _gui:
+
+Graphical User Interfaces
+=========================
+There are several graphical user interfaces (GUIs)
+prepared to show case the features of the library. 
+The codes related to GUIs are in the ``src/gui`` directory.
+
+
+Launching
+=========
+There are different ways to launch the GUIs depending 
+on how you obtain the library.
+
+
+

docs/index.rst

@@ -0,0 +1,17 @@
+TomorrowCities Python Package
+=============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: First Steps:
+
+   install
+   quickstart
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/install.rst

@@ -0,0 +1,18 @@
+:: _install:
+
+Installation
+============
+
+.. highlight:: bash
+
+Prerequisites:
+
+* Python >= 3.9
+
+To install TomorrowCities Python package you can use `pip`:
+
+.. code-block:: bash
+
+   pip install tomorrowcities
+
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/quickstart.rst

@@ -0,0 +1,22 @@
+Quick Start
+===========
+
+.. highlight:: python
+
+After :doc:`/install`, you can import `tomorrowcities` 
+package and start generating exposure data or calculating
+impact metrics.
+
+.. code-block:: python
+
+   import tomorrowcities as tc
+   
+   dg = tc.DataGenerator(parameter_file='distribution_table.xlsx',
+                    land_use_file='landuse.zip')
+
+   building, household, individual, land_use = dg.generate(seed=42)
+
+   metrics = dg.run_engine(building, household, individual, land_use,
+                hazard_scenario="FLOOD", hazard_data="flood.xlsx", policies=None):
+
+