tpython_api.rst - sphere - GPU-based 3D discrete element method algorithm with optional fluid coupling
 (HTM) git clone git://src.adamsgaard.dk/sphere
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) LICENSE
       ---
       tpython_api.rst (792B)
       ---
            1 Python API
            2 ==========
            3 The Python module ``sphere`` is intended as the main interface to the ``sphere``
            4 application. It is recommended to use this module for simulation setup,
            5 simulation execution, and analysis of the simulation output data.
            6 
            7 In order to use the API, the file ``sphere.py`` must be placed in the same
            8 directory as the Python files. 
            9 
           10 Sample usage
           11 ------------
           12 Below is a simple, annotated example of how to setup, execute, and post-process
           13 a ``sphere`` simulation.  The example is also found in the ``python/`` folder as
           14 ``collision.py``.
           15 
           16 .. literalinclude:: ../../python/collision.py
           17    :language: python
           18    :linenos:
           19 
           20 The full documentation of the ``sphere`` Python API can be found below.
           21 
           22 
           23 The ``sphere`` module
           24 ---------------------
           25 .. automodule:: sphere
           26    :members:
           27