CityDigitalTwin Rhino plugin 1.0.1
=====================================

Export Rhino models to CityDigitalTwin - the urban climate simulation platform by
Planete GreenLeaves.  https://greenleaves.app


INSTALL
-------

The easiest way to install and stay up to date is Rhino's own package manager:

    In Rhino, run:  _PackageManager
    Search for:     CityDigitalTwin
    Click Install, then restart Rhino.

To install from this download instead:

  1. Open the folder for your Rhino version:
         Rhino8/   for Rhino 8  (Windows and Mac)
         Rhino7/   for Rhino 7  (Windows)
  2. Drag CityDigitalTwin_ExportAsciiSTL.rhp onto the Rhino window.
     (Or run PlugInManager, click Install, and pick the file.)
  3. Restart Rhino.


COMMANDS
--------

  CDT_AssignType        Select objects and assign a vegetation, soil, road, water
                        or building type to them.
  CDT_ExportAsciiSTL    Export the model to a .cdt archive.


QUICK START
-----------

  1. Put your geometry under top-level layers named Buildings, Trees, Grasses,
     Grounds, Roads and Waters. The layer decides what an object physically
     becomes in the simulation, so this is the important step.
  2. Optionally select objects and run CDT_AssignType to tag them with a type.
  3. Save the model, then run CDT_ExportAsciiSTL.
  4. Rename the resulting .cdt file to .zip and unzip it.
  5. Upload the .stl in the web app's Basic setup, and each CSV on its matching
     Advanced setup page.

Full instructions are in User_Guide.md, including how solid names are built and
how to keep them stable across re-exports.

samples/tutorial.3dm is a worked example you can export straight away.


TYPES vs ASSIGNMENTS
--------------------

The plugin records WHICH type an object has. It does not define what that type IS.
Vegetation, soil, road and water types, and building archetypes, are defined in the
CityDigitalTwin web app or desktop GUI when you create a project. A name you type in
Rhino must match a type defined there, or the web app reports the row as skipped.


REQUIREMENTS
------------

  Rhino 8 on Windows is the tested configuration.  The Rhino7 folder is built but
  has not been verified in Rhino 7.  Model units must be set to Meters.


LICENSE
-------

  MIT.  See LICENSE.


SUPPORT
-------

  contact@greenleaves.app
