/BGWpy

BerkeleyGW python

Primary LanguagePythonOtherNOASSERTION


A python module to operate BerkeleyGW

Documentation

We recommend learning the basic usage from the examples provided with the source distribution in ~BGWpy/Examples/. The docstrings of the various objects also contain information and can be accessed from a python interpreter with

help(BGWpy.<object>)

or from ipython with

In  [1]: BGWpy.<object>?

Requirements

The following software and modules are required to use BGWpy.

Note that the binary executables of BerkeleyGW must be found in your PATH environment variable.

Installing

Once you have satisfied the requirements, install the package with

python setup.py install

See the file INSTALL for more information about configuring the module's default parameters.

License

This software is free to use under the BSD license. See license.txt for more information.