Commit 56ae48ca authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

docs use repository bfps instead of installed bfps

parent 86bb06e6
================================
Big Fluid and Particle Simulator
================================
......
......@@ -85,9 +85,9 @@ def randomize_phases(v):
randomize the phases (assuming that the initial field is complex
valued; otherwise I'm not sure what will come out).
:param v: `numpy.array` of dimension at least 3.
:param v: ``numpy.array`` of dimension at least 3.
:returns: `v` with randomized phases (i.e. a Gaussian random field).
:returns: ``v`` with randomized phases (i.e. a Gaussian random field).
"""
phi = np.random.random(v.shape[:3])*(2*np.pi)
phi[0, 0, 0] = 0.0
......
API
===
bfps
----
.. automodule:: bfps
:members:
:undoc-members:
:inherited-members:
:show-inheritance:
bfps.NavierStokes
-----------------
.. automodule:: bfps.NavierStokes
.. autoclass:: NavierStokes.NavierStokes
:members:
:undoc-members:
:inherited-members:
......@@ -22,7 +13,7 @@ bfps.NavierStokes
bfps.tools
----------
.. automodule:: bfps.tools
.. automodule:: tools
:members:
:undoc-members:
:inherited-members:
......
......@@ -21,6 +21,7 @@ import shlex
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('../bfps'))
# -- General configuration ------------------------------------------------
......
......@@ -8,12 +8,12 @@ Welcome to bfps's documentation!
================================
.. toctree::
:maxdepth: 2
:maxdepth: 2
/_static/README
/_static/overview
/_static/development
/_static/api
/_static/README
/_static/overview
/_static/development
/_static/api
Indices and tables
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment