~ubuntu-branches/ubuntu/saucy/python-demgengeo/saucy

« back to all changes in this revision

Viewing changes to README

  • Committer: Package Import Robot
  • Author(s): Anton Gladky
  • Date: 2011-11-18 21:47:18 UTC
  • Revision ID: package-import@ubuntu.com-20111118214718-4ysqm3dhpqwdd7gd
Tags: upstream-0.99~bzr106
ImportĀ upstreamĀ versionĀ 0.99~bzr106

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
#############################################################
 
2
##                                                         ##
 
3
## Copyright (c) 2007-2011 by The University of Queensland ##
 
4
## Earth Systems Science Computational Centre (ESSCC)      ##
 
5
## http://www.uq.edu.au/esscc                              ##
 
6
##                                                         ##
 
7
## Primary Business: Brisbane, Queensland, Australia       ##
 
8
## Licensed under the Open Software License version 3.0    ##
 
9
## http://www.opensource.org/licenses/osl-3.0.php          ##
 
10
##                                                         ##
 
11
#############################################################
 
12
 
 
13
lsmgengeo: Scriptable Geometry Creation Library for ESyS-Particle
 
14
https://launchpad.net/esys-particle
 
15
 
 
16
OVERVIEW
 
17
Lsmgengeo 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.  An lsmgengeo 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.
 
18
 
 
19
FEATURES
 
20
   * Python API for geometry creation
 
21
   * scriptable creation of model geometry files for ESyS-Particle or other DEM simulations
 
22
   * scriptable creation of particle clusters which form the smallest units in a model geometry
 
23
 
 
24
DEVELOPMENT HISTORY
 
25
Lsmgengeo has been developed in-house within the Earth Systems Science Computational Centre (ESSCC) 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 lsmgengeo development.
 
26
 
 
27
CONTRIBUTORS
 
28
See the AUTHORS file for a list of contributors to lsmgengeo.
 
29
 
 
30
GET INVOLVED
 
31
The lsmgengeo 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).
 
32