Installing Opus & UrbanSim > Opus Directory Tree

The Opus Directory Tree

The Opus GUI uses xml configuration files that specify the model configuration, where the data is located, and so forth. These project files expect a particular directory layout. The base directory for an opus installation (called opus by default) should contain the following subdirectories and files:

opus/
    data/
        eugene_gridcell/
            baseyear_cache/
                1980/
                    [baseyear cache files here]
            runs/
                [the system will put directories for run results here]
        seattle_parcel/
            baseyear_cache/
                2000/
                    [baseyear cache files here]
            runs/
                [the system will put directories for run results here]
    docs/
        installation/
        opus-userguide.pdf
        opus-userguide/
            [files for the html version of the user guide go here]
        tutorials/
    project_configs/
        eugene_gridcell_default.xml
        seattle_parcel_default.xml
        [other personal xml project configurations go here]
    settings/
        database_server_configurations.xml
        gui_config.xml
    src/
        opus_core/
        urbansim/
        [all the other Python packages]

A zip file containing this entire directory structure, is available on the download page. Be sure and get the zip file corresponding to the version of the code you are using.

You can unzip this to a convenient location on your local disk (say your home directory). The environment variable OPUS_HOME should point to the location of the opus directory. You can optionally have an environment variable OPUS_DATA_PATH that points to the data directory; if this variable is missing it defaults to OPUS_HOME plus data. The settings subdirectory contains configuration information for database server cofigurations and for preference settings for the GUI; you shouldn't need to do anything with this. The src directory is empty in the development version -- populate this from the subversion repository. (Or you can keep your source code in a different directory; it doesn't need to be at this location. Make sure your PYTHONPATH variable is correctly set to point to the source code directory, wherever you put it.) Finally, in the development version of the zip file, docs is also empty -- you can find the latest documentation here. Documentation for the exact version that you have checked out from subversion is in the project opus_docs.