Repository layout

This is a very brief guide to help navigate the CSP source code repository. Note that most developers will only check out and work on trunk/.

Top level

trunk/ - This is the main line of development. The latest revision of trunk constituting the "current state" of CSP.

branches/ - Each subdirectory here constitutes a separate line of development that occurs independently of the trunk. Branches are created by copying either the entire trunk or a subdirectory of the trunk at a given revision to a new directory under branches/. Branches used for private development should include the developer's name. For more information on branches, see the Subversion documentation (http://svnbook.red-bean.com/svnbook/book.html#svn-ch-4). You should never check out all of branches/; if you need to work on a branch, be sure you only check out that specific branch.

tags/ - Like branches, tags are copies of the trunk at a given revision. Unlike branches, tags are never modified once created. We use tags to give understandable names to important revisions, such as those used to cut a new release version. Since each tag is a full copy of the repository, you should never check out all of tags/.

trunk/csp/base - A python package containing modules that are used by multiple projects.

trunk/csp/csplib - This package provides a library for managing simulation data.

trunk/csp/cspsim - The CSP demo simulator package. This is currently the main application of CSP. It depends on several third-party libraries (see CurrentBuildDependencies), as well as the other packages in trunk/.

trunk/csp/data - Data resources for the simulation, excluding terrain. The terrain data must be downloaded separately from the SF project page and uncompressed into trunk/csp/data/terrain.

trunk/csp/modules/chunklod - This is a customized version of the ChunkLOD module (http://www.vlad1.com/~vladimir/projects/osg/OSG) (based on the ChunkLOD demo (http://sourceforge.net/projects/tu-testbed/) by Thatcher Ulrich), which provides an alternate terrain engine for the simulation.

trunk/csp/modules/demeter - This is a customized version of the Demeter (http://www.terrainengine.com/) terrain engine. This is currently the default terrain engine for the simulation.