GENESIS: Documentation

Related Documentation:

Introduction to GENESIS for Developers

The documentation linked to here is for GENESIS users who want to contribute to the development of extended functionality of the GENESIS simulation platform, rather than for those users who want to do scientific simulations. (Although a single individual may want to do both.) Developer documentation provides links to more technical documentation supporting software development. It is assumed that you are familiar with the monotone version control software used by GENESIS (for more information see Version Control). Links to the more general user documentation can be found at the Level 1 Documentation Contents Index.

The federated development of GENESIS software components proceeds via a set of monotone source code servers that are accessible from the internet. monotone has functions to properly merge source code changes regardless of the location where they have been made: at home, in your office or on the airplane. The functionality required for the integration of the monotone source code servers is available from the DeveloperPackage. Several dedicated buildbot systems pull the latest version of the code to build, install and run regression tests.

Becoming a GENESIS Developer

In principle anyone can become a GENESIS developer, all that is required is a desire to focus on tool and documentation development rather than model building and simulation. There are at least three ways to be a GENESIS developer:

Member of the GENESIS Core Development Team

Core development of the GENESIS software platform is undertaken by the members of the GENESIS Core Development Team.

Member of the GENESIS Developers Federation

To become a GENESIS developer send a request to genesis@genesis-sim.org with the subject “New Developer Request”. You will be registered as a GENESIS developer and receive a key that will allow you to pull and push documentation and code to the GENESIS repositories.

To learn more about the GENESIS repositories and version control see Version Control.

To learn more about installation on your local machine as a GENESIS developer see Developer Installation.

Independent Developer

GENESIS is structured in such a way that it is possible to download the code from http://repo-genesis3.cbi.utsa.edu/src/. You can then proceed entirely independently with your own code and documentation development. To do this see the Independent Installation documentation. It describes how to set up your own choice of version control and associated file repositories independently of the GENESIS website.