.. ropensci-review-tools documentation master file, created by
   sphinx-quickstart on Wed Aug 25 10:43:40 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Urban Analyst
#############

This is the documentation of `the Urban Analyst platform
<https://urbananalyst.city>`_. Contributions to, or questions regarding, this
documentation, are welcome at `this GitHub repository
<https://github.com/UrbanAnalyst/docs>`_.


.. toctree::
   :maxdepth: 1
   :numbered:
   :caption: Contents

   content/intro.rst
   content/overview.rst
   content/example.rst
   content/variables.rst
   content/data.rst
   content/software.rst


Following the introduction, the :ref:`second chapter<Overview>` provides a
brief overview of the main components of the Urban Analyst platform. This is
followed by a :ref:`walk-through example<Example>` comparison between Berlin,
Germany and Paris, France, illustrating the kinds of comparisons enabled by the
Urban Analyst platform. The |varchapter| describes all variables included in
the *Urban Analyst* platform, and the final two chapters describe all
|datachapter| used to derive these variables, and descriptions of all
|swchapter| used to generate the UA variables, including links to all
open-source software repositories.

.. |varchapter| raw:: html

   <a href="https://docs.urbananalyst.city/content/variables.html">
   <em>UA Variables</em> chapter</a>


.. |datachapter| raw:: html

   <a href="https://docs.urbananalyst.city/content/data.html">
   <em>Data Sources</em></a>


.. |swchapter| raw:: html

   <a href="https://docs.urbananalyst.city/content/software.html">
   <em>Software and Algorithms</em></a>