#############################################################
##                                                         ##
## Copyright (c) 2007-2014 by The University of Queensland ##
## Centre for Geoscience Computing                         ##
## http://earth.uq.edu.au/centre-geoscience-computing      ##
##                                                         ##
## Primary Business: Brisbane, Queensland, Australia       ##
## Licensed under the Open Software License version 3.0    ##
## http://www.opensource.org/licenses/osl-3.0.php          ##
##                                                         ##
#############################################################

GenGeo: Scriptable Geometry Creation Library for ESyS-Particle
https://launchpad.net/esys-particle

OVERVIEW
GenGeo is a library for creating geometry files used by ESyS-Particle and other software implementing the Discrete Element Method (DEM).  It provides a convenient method for creating arbitrary geometries comprised of spherical particles and bonded particle clusters.  A GenGeo script written in Python specifies the geometry that will be generated then written to a text file in a human readable format. The geometry file can then be read by ESyS-Particle or another DEM package to initialise particle locations.

FEATURES
   * Python API for geometry creation
   * scriptable creation of model geometry files for ESyS-Particle or other DEM simulations
   * scriptable creation of particle clusters which form the smallest units in a model geometry

DEVELOPMENT HISTORY
GenGeo has been developed in-house within the Centre for Geoscience Computing at the University of Queensland, Brisbane, Australia since 2008.  One of the founding developers, Dr. Steffen Abe, is based at RWTH Aachen, Germany and continues to actively contribute to GenGeo development.

CONTRIBUTORS
See the AUTHORS file for a list of contributors to GenGeo.

GET INVOLVED
The GenGeo software development team (https://launchpad.net/~esys-p-dev) is always willing to welcome new developers interested in contributing to the code-base. If you would like to contribute, please contact Dion Weatherley (d.weatherley@uq.edu.au).

