boutpy
0.0.1.dev1
________ _______ _____ __________
___ __ )__ __ \__ / / /___ __/______ ______
__ __ |_ / / /_ / / / __ / ___/ /____/ /_
_ /_/ / / /_/ / / /_/ / _ / /_ __//_ __/
/_____/ \____/ \____/ /_/ /_/ /_/
Version: 0.0.1.dev1, Last updated: June 05, 2018
Wellcome to BOUT++ boutpy documentation!
BOUT++ boutpy is a Python2.x
package intended to provide some common tools required for performing Plasmas
Fluid Simulations with BOUT++ framework. The BOUT++ boutpy in the latest
release BOUT++ v4.0.0 is Python3.x supported.
Table of Contents
It’s highly encouraged to use Anaconda as the python environment. Before starting to use the tools in this package, some envrionment variables and required packages are suggested to be set up first.
1 2 3 | $ pip install boutpy
# if "IOError: Permision denied" occoured, try:
$ pip install --user boutpy
|
The BOUT++ documents are available here. The user manual for this python package is on ReadTheDocs
It’s strongly encouraged to follow the standard Python style conventions as described here:
You can use a code checker:
In order to facilitate documentation using Sphinx, the numpydoc extension is used
so that the docstrings will be handled correctly. The User Manual and
an example of
numpydoc conventions are available.