Merge branch 'release/v2.3a2'

.gitattributes

@@ -0,0 +1 @@
+*.psd filter=lfs diff=lfs merge=lfs -text

conf.py

@@ -38,7 +38,11 @@
     'sphinx.ext.mathjax',
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages']
+    'sphinx.ext.githubpages',
+    'matplotlib.sphinxext.only_directives',
+    'matplotlib.sphinxext.plot_directive',
+    'IPython.sphinxext.ipython_directive',
+    'IPython.sphinxext.ipython_console_highlighting']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -57,6 +61,7 @@
 
 # The master toctree document.
 master_doc = 'index'
+numfig = True
 
 # General information about the project.
 project = u'umidocs'
@@ -70,7 +75,7 @@
 # The short X.Y version.
 version = u'2.3'
 # The full version, including alpha/beta/rc tags.
-release = u'2.3'
+release = u'2.3a2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -187,6 +192,10 @@
 
 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ['search.html']
+epub_cover = ('_static/cover.png', 'epub-cover.html')
+epub_theme_options = {'relbar1' : True, 'footer' : True}
+epub_tocdepth = 2
+epub_show_urls = 'no'
 
 
 

docs/design-access-example.rst

@@ -0,0 +1,11 @@
+
+.. _design_access_example:
+
+Example
+=======
+
+This file is for you to test if you are modeling for a Walkscore simulation correctly. After downloading the file, you have to set the location and set the building information for at least one Brep on the "Buildings" layer. Follow the :ref:`design_access_setup_model` steps, and you will find that walkscore and bikescore run correctly.
+
+.. only:: html
+
+   :download:`Walkscore_Example.3dm <./examples/Walkscore_Example.3dm>`

docs/design-access-intro.rst

@@ -0,0 +1,21 @@
+
+.. _design_access:
+
+Design Accessibility
+====================
+
+Motivation
+----------
+
+The utilization of high density and diversity in land-use is an effective strategy that decreases automobile dependency and contributes to more sustainable modes of transportation (namely walking and biking), as a short proximity between amenities encourages human powered transportation (HPT).To quantify the impact of applying such principles, the integration of simulation tools that evaluate cities’ “walking friendless” in the design process is becoming significant. Assessment of neighborhood walkability has long been considered a function of quarter mile to one and a half mile walking distances from housing units to vital amenities. This idea has been adapted by many walkability evaluation schemes in different forms, and has been proven to be a good indicator of “walking environments.” Popular indices such as the “Walkscore” have been validated in terms of estimating neighborhood walkability and health as well as real estate prices.
+
+How it Works
+------------
+
+Walkscore measures the ease of residing in a certain area without depending on your car. We adapted this web-based tool to be used within the design environment of Rhino as a comprehensive modeling approach. The algorithm tests points of interest for proximity to nine North-American oriented amenities (Schools, Restaurants, Coffee, Shopping, Entertainment, Parks, Banks, Grocery and Books). Each amenity receives a different weight based on importance. Egress points for addresses are then rewarded based on distances to amenities, and a polynomial distance decay function is used to calculate scores. Within a distance of quarter mile, a full score is received, and at one mile, amenities receive about 12% of the score as a penalty. After one mile, scores slowly decrease with greater distance, until it reaches zero at 1.5 miles. There are other reward scores received by examined points based on street intersection densities and average block length. Scores range from 0 to 100.
+
+Scoring is implemented by constructing a pedestrian travel network and performing a series of shortest-path calculations using Dijkstra's algorithm.
+
+.. raw:: html
+
+   <iframe width="100%" max-height="315" height="315" src="https://www.youtube-nocookie.com/embed/qgw62iRkbEU?rel=0" frameborder="0" allowfullscreen></iframe>

docs/design-access-setup-model.rst

@@ -0,0 +1,77 @@
+
+.. _design_access_setup_model:
+
+Setting Up a Rhino Model
+========================
+
+
+.. important:: When creating a new Rhinoceros model for Umi, always use `Meters` as the unit system.
+
+Step 1: Starting a new umi project
+----------------------------------
+
+Create a new umi project or start from an existing one. To create a new project, follow the steps detailed in :ref:`setup_model`.
+
+There is no need to set site information or set building information at this point. Click on "Simulate" to setup layers specific to mobility and then on the "Mobility" icon on the left. Click on "Create amenity layers" to generate layers appropriate for mobility simulation.
+
+Step 2: Modeling Streets, Buildings and Amenities
+-------------------------------------------------
+
+Streets
+```````
+
+.. figure:: ./assets/design-access-setup-model-si3kr8e6.png
+   :scale: 100 %
+   :align: center
+   :name: street_layer
+
+   ..
+
+   On the Streets layer, streets can be drawn as any lines, curves or line-like curves.
+
+Buildings
+`````````
+
+Building massing can take the form of any Brep, and are placed exclusively on the “Buildings” layer. This should be done by drawing geometry and then setting it up in the settings button. Choose the Brep and click on "Settings" to give the building a name. That is enough for mobility simulation.
+
+.. figure:: ./assets/design-access-setup-model-s93j4u5d.png
+   :scale: 100 %
+   :align: center
+   :name: building_on_street
+
+   ..
+
+   Draw buildings as Breps.
+
+.. important:: Each Brep has to be connected to the streets network by a path that touches the massing. This is because the algorithm that generates a starting “egress” point for each building searches the start and end points of each curve in the model, and the nearest point becomes a door for the Walkscore simulation. If it is not connected, simulation will run by projecting an egress point to the nearest street, even if not connected.
+
+Amenities
+`````````
+
+Amenities are modeled as points on the streets network. They have to be placed precisely on a street curve, However, if they are not they will be projected to the nearest street line. A good tip is to use `"Osnap" <http://docs.mcneel.com/rhino/5/help/en-us/user_interface/object_snaps.htm>`__ to snap to the nearest curve on the streets layer.
+
+.. important:: place amenity points on the streets network, but not on the end of the curve that touches the building massing. This will make the algorithm consider that “start” and “end” points the same, and Walkscore will fail.
+
+.. figure:: ./assets/design-access-setup-model-si4j5c2p.png
+   :scale: 100 %
+   :align: center
+   :name: parks_and_points
+
+   ..
+
+   Amenities are drawn as points and parks as surfaces
+
+
+The “Parks” amenity is the only amenity modeled as surfaces, and it has to be surrounded with street curves on all sides (regardless of the geometry). If a park is placed as a surface, it is recommended to model it by tracing an empty space between street curves.
+
+Typically a Walkscore simulation will include streets, massings connected to the  streets, amenity points and park surfaces.
+
+Step 3: Running a Simulation
+----------------------------
+
+After selecting the "Simulate" button, choose the “Mobility” tab. You can run both the Walkability simulation and the Bikeability Simulation by pressing "Run All." The next section explains how both algorithms work.
+
+Step 4: Results Visualization
+-----------------------------
+
+After a simulation runs, a new layer is created with simulation results. This will take the form of false colored buildings.

docs/energy-module-advanced.rst

@@ -0,0 +1,7 @@
+.. _energy-module-advanced:
+
+Advanced Settings
+=================
+
+.. todo::
+   Section to be written

docs/energy-module-overview.rst

@@ -0,0 +1,55 @@
+.. |br| raw:: html
+
+   <br />
+
+.. _energy-module-overview:
+
+Energy Module Overview
+======================
+
+.. container:: align-right
+
+   .. figure:: assets/energy-module-overview-s83k47fm.png
+      :scale: 35 %
+      :align: center
+      :name: figure_1
+
+      Input Geometry
+
+   .. figure:: assets/energy-module-overview-slk3yf86.png
+      :scale: 35 %
+      :align: center
+      :name: figure_2
+
+      Insolation Analysis Mesh |br| [high(red) low(blue)]
+
+   .. figure:: assets/energy-module-overview-s83kd7s5.png
+      :scale: 35 %
+      :align: center
+      :name: figure_3
+
+      Clustering
+
+      .. image:: assets/energy-module-overview-sjd63jdf8.png
+         :scale: 50%
+         :align: center
+
+      .. raw:: html
+
+         <p style=" text-align: center">low - insolation - high</p>
+
+   .. figure:: assets/energy-module-overview-s93k47f8.png
+      :scale: 35 %
+      :align: center
+      :name: figure_4
+
+      Shoebox clusters
+
+
+The operational energy model simulation uses your umi buildings and building template settings as well as the shading geometry on the umi shading layers. A small input geometry example is shown in :numref:`figure_1`.
+
+First your building envelope is subdivided into floor volumes according to your floor to floor height settings in the building template. Along the facades of each floor volume a solar insolation analysis is performed using Radiance / GenCumulativeSky. Internally your geometry is meshed and then handed over to radiance. :numref:`figure_2` shows a typical result of this insolation simulation.
+
+This radiation data as well as the basic facade surface orientation are then used to cluster facade regions of each building by solar micro climate similarity - see :numref:`figure_3` for an example. Each color represents a cluster. The number of clusters is a user setting and can be specified for each orientation (a typical cluster count per facade is two).
+
+The Shoeboxer then assigns an area weight to each cluster centroid. This centroid is then also the location for a shoebox model that then represent the cluster. See :numref:`figure_4`. Each Shoebox or Cluster is written out as IDF file and is simulated with EnergyPlus. The final simulation step is to gather all shoebox data and aggregate the building result. For further details regarding the method please refer to the BS2014 paper online. The method is still under active development and a validation study is on the way.

docs/first.rst

@@ -0,0 +1,39 @@
+
+Umi \| First steps
+==================
+
+Requirements
+------------
+
+Rhinoceros3D version 5-64 bit (Windows only)
+
+Download & Install
+------------------
+
+To download UMI,please follow this
+`link <http://urbanmodellinginterface.ning.com/page/download>`__ and
+fill out the form.
+
+.. _setup_model:
+
+Opening/Creating a project
+--------------------------
+
+When working with UMI projects, it is important to use the umi functions
+and **NOT** the Rhino commands for “Opening” and “Saving” a project. Umi
+creates it’s own file system (\*.umi) which is a package containing all
+relevant files and data needed for a project.
+
+To create a new project, simply click on the UMI button and select “open
+project” or “new project” and browse to the folder location of your
+choice. Once a project has been opened.
+
+.. figure:: ./assets/first-kd95h2j87.png
+   :align: center
+   :alt: The umi menu
+
+   The umi menu
+
+Important: Working units must be in
+Meters. To change them, in Rhino, go to > File — Properties — Units —
+Model Units : Change to “meters”