Prior to installing CityEngine, please review the system requirements.
To install and run CityEngine, you will need the CityEngine installer (setup program) and the License (Activation Code or .dat file). Please note that the Trial Version does not require a license or activation.
CityEngine 2011.2 is a maintenance release which includes all the functionality from CityEngine 2011.1, plus several improvements and bug fixes. CityEngine 2011.2 may be installed on its own, or installed directly on top of an existing installation of CityEngine 2011.1.
Double-click on the setup program's .exe file. The install wizard will guide you through the installation process.
After you finish the installation, CityEngine can be launched by double-clicking the CityEngine desktop shortcut. Typically, CityEngine can also be started from the "Windows Start Menu" by going to Start > All Programs > Esri > Esri CityEngine 2011.
Mac OS X
Double-click on the setup program's .dmg file. A dialog window will appear. Drag the "Esri CityEngine 2011" application to your Applications Folder. Double click the icon from the Applications Folder to use the application.
Download the setup program's .bin file to a directory on your local machine where you have full 'rwx' (read, write, execute) permissions. Change the current directory ('cd') to the download location, and extract the .bin file by typing ./[product_name_Setup].bin. This will create a Esri_CityEngine_2011 directory. Change the current directory to the Esri_CityEngine_2011 directory and execute the ./CityEngine script file to begin the CityEngine Welcome Wizard. Choose your license method from the Activation code dropdown menu and select Create License. Follow the wizard prompts to complete the installation and launch CityEngine.
CityEngine must be activated before you can continue. To start the activation process, launch CityEngine and follow the Welcome Wizard to specify your activation options.
- Activation code: Select this option if you have purchased a Node-Locked License and will activate online. Enter the activation code that was e-mailed to you by Esri Customer Service and click Get License. This process requires an Internet connection.
- License File: Select this option if you have purchased a Node-Locked License and will activate offline. If you do not have an Internet connection, you can request a Node-Locked License file from Esri Customer Service by emailing email@example.com along with the MAC address of your machine. Customer Service will e-mail your Node-Locked License as a *.dat file. Save this file to your machine, click Browse and select the Node-Locked License file received from Esri Customer Service.
- License Server: Select this option if you have purchased a Floating License. Enter the hostname of your license server set up in the Installing the CityEngine License Server section and click Create License button. Request a Floating License file from Esri Customer Service by e-mailing firstname.lastname@example.org with the MAC address and Hostname of the machine you intend to use as a license server. Customer Service will e-mail your Floating License file as a *.dat file. Please note that Floating Licenses are only available for CityEngine Advanced.
Click Next and follow the instructions to specify the Workspace Location after successful activation. Note: On Linux, the user should have full 'rw' (read, write) permissions to the workspace location. Click Launch from the Welcome Wizard to start CityEngine. CityEngine will now guide you through an overview of available resources.
Changing the License
CityEngine licenses can be changed after installation and successful activation by selecting Help > Change License. This process will require restarting CityEngine. On the next startup of CityEngine, you will be able to select your new license option.
Note: The license change is remembered and unrevertable. After restarting the program, CityEngine must be activated before you can continue.
If you have purchased Floating (Concurrent Use) Licenses, you need to install the CityEngine License Server.
- Download the Windows version of the License Server from the Esri Customer Care Portal.
- Extract the zip file to a location on the machine you intend to use as your license server.
- Save the license file (*.dat) received from Esri Customer Service to the extracted folder.
- Launch lmtools.exe
- On the Config Services Tab, type in the Service Name. For example: CityEngineLS.
- Click Browse next to the Path to the lmgrd.exe field and select the lmgrd.exe in the WindowsLS folder.
- Click Browse next to the Path to the license file and select the license file (*.dat) from Step 3.
- Click Browse next to the debug log file, select the path and enter a name for the log file. For example: CityEngineLS.log.
- Optionally, you can choose to install this as a Windows Service and start it at Power Up by checking the 2 boxes below the paths.
- Click Save Service.
- On the Start/Stop/Reread tab, click Start Server. You will see a "Server Start Successful" message at the bottom of the window.
- The lmtools utility can be closed once the Server has been started.
Mac OS X and Linux
- Download the Mac or Linux version of the License Server from the Esri Customer Care Portal.
- Extract the file to a location on the machine you intend to use as your license server. Note to Linux users: You must have rwx (read-write-execute) permissions to the extracted folder.
- Save the license file (*.dat) received from Esri Customer Service to the extracted folder.
- From the terminal window, change directory to the extracted folder.
- Run the following command to start the license server: ./lmgrd -c <licensefilename>.dat
CityEngine comes with an installer for the Windows, Mac and Linux operating systems. The CityEngine and License Server installers are available from the Esri Customer Care Portal after purchase.
A 30-day trial version of CityEngine is also available for download.
First, download the CityEngine installer from the Esri Customer Care Portal, then follow the instructions in the installation wizard after launching the CityEngine installer.
Note: After the installation process is complete, CityEngine must be activated before you can continue. To start the activation process, launch CityEngine and follow the Welcome Wizard to specify your activation options. The trial version does not need to be activated.
Node-Locked (Single Use) as well as Floating License (Concurrent Use) solutions are available.
- Node-Locked License (bound to one computer): CityEngine Basic and Advanced
- Floating License (network license, suited for multi-user environments): CityEngine Advanced
A Node-Locked License (a.k.a. Single Use license) works just on one computer and is bound to its hardware. Setup is easy & quick and no network connection is required after installation. No hardware dongle is required.
Floating Licenses (a.k.a. Concurrent Use licenses) are well suited for multi-user environments because a limited number of licenses can be shared among a larger number of users over time. Licenses are not bound to specific computers and are obtained on demand:
- When CityEngine is run by a user, it requests a license from the license server. If a license is available the license server allows CityEngine to run.
- When the user finishes using CityEngine, or when the allowed license period expires, the license is reclaimed by the server and made available to other users.
For example: when you purchase 20 CityEngine Advanced licenses, a maximum of 20 licenses can be used simultaneously in your network.
The license server can manage licenses over a local area network, an intranet or virtual private network, or the Internet. Thus, for normal CityEngine usage, a network connection to the license server is required. To be able to run the CityEngine in offline environments, floating licenses can be conveniently "borrowed" (i.e. checking out a license) for a specified period (see below).
Yes, licenses can temporarily (days / weeks) be borrowed from the license server. Borrowing a license is a temporary checkout of a floating license from the license server to use the CityEngine during a period where no connection to the license server is possible.
To borrow a license, click on “Borrow License…” in the Help-Menu of CityEngine and select the borrow duration in the dialog. Note that you have to borrow a license before your trip (i.e. when you still are connected to the license server).
For the selected time frame, the borrowed license will not be available on the license server for other users, thus limit your borrow duration to the duration you plan to work offline.
A Media Access Control address (MAC address) is the unique identifier of your network adapter. For users who have to request a Floating License file, or Node-Locked License file from Esri Customer Service, the MAC address of the machine needs to be provided. The format is 12 hexadecimal digits, separated by hyphens (-) or colons (:), for example 01-23-45-67-89-ab or 01:23:45:67:89:AB.
Start CityEngine after CityEngine installation is complete. The MAC address is displayed in the top of the welcome wizard dialog. Alternately, for instructions on how to find the MAC address on a specific platform, please see below.
The list below summarizes options to find a computer's MAC address:
- Windows NT and newer: ipconfig /all
- Mac: ifconfig -a
- Linux: /sbin/ifconfig -a
- Open the DOS command prompt (“cmd.exe”): Click on the Windows "Start" button -> "Programs" ->"Accessories" ->"Command Prompt". Note: In Windows 7 and Vista operating system, you can open the DOS command prompt using the Start menu: Type “cmd” in the Search box on the Start menu, and press Enter.
- Enter ”ipconfig/all”.
- The "Physical Address" is your MAC address, in the form of XX-XX-XX-XX-XX-XX (a combination of 12 letters and numbers) Note: If you have installed multiple network adapters and multiple "Physical Addresses" are listed, please choose the active adapter (the one which enables web access). This is usually the Ethernet adapter Local Area Connection.
Mac OS X
- Open the Apple menu at the top left corner of the screen. Click "About this Mac".
- Click the "More Info…" button, which opens the iMac window.
- Click the "Network" tab in the contents at the left of the window. In an AirPort card, click the "Ethernet" tab to find the "MAC address" in the form of XX-XX-XX-XX-XX-XX (a combination of 12 letters and numbers). The ID is located next to the "Ethernet ID" label.
- Open a terminal window.
- Enter “/sbin/ifconfig –a”.
- On the first line of the ‘eth0’ section, the MAC address is the HWaddr XX-XX-XX-XX-XX-XX (a combination of 12 letters and numbers).
You need an Internet connection to be able to download tutorials and examples, and to watch learning videos.
Tutorials and Examples can be downloaded after CityEngine has been successfully installed and activated by selecting “Help” -> “Download Tutorials and Examples...”. Alternately, you can manually download the Tutorials and Examples from here.