Skip to content
Snippets Groups Projects
Commit 2e6fdd67 authored by Cristian Lalescu's avatar Cristian Lalescu
Browse files

removes tox configs and tweaks documentation

parent 22b80a4b
Branches
Tags
No related merge requests found
...@@ -7,7 +7,7 @@ Development ...@@ -7,7 +7,7 @@ Development
Versioning guidelines Versioning guidelines
--------------------- ---------------------
Version tracking for :mod:`bfps` is done with ``git`` (see https://git-scm.com/ Version tracking for :mod:`TurTLE` is done with ``git`` (see https://git-scm.com/
for description). for description).
The branching model described at The branching model described at
http://nvie.com/posts/a-successful-git-branching-model/ should be http://nvie.com/posts/a-successful-git-branching-model/ should be
...@@ -15,8 +15,8 @@ adhered to as strictly as possible. ...@@ -15,8 +15,8 @@ adhered to as strictly as possible.
The usable ``VERSION`` number will be constructed according to semantic The usable ``VERSION`` number will be constructed according to semantic
versioning rules (see http://semver.org/), ``MAJOR.MINOR.PATCH``. versioning rules (see http://semver.org/), ``MAJOR.MINOR.PATCH``.
In principle, if you use :mod:`bfps` and you've created children of the In principle, if you use :mod:`TurTLE` and you've created children of the
:class:`NavierStokes <bfps.NavierStokes.NavierStokes>` class, you should not need to rewrite your code unless :class:`DNS <TurTLE.DNS>` class, you should not need to rewrite your code unless
the ``MAJOR`` version changes. the ``MAJOR`` version changes.
There are 2 main branches, ``master`` and ``develop``. There are 2 main branches, ``master`` and ``develop``.
...@@ -56,22 +56,5 @@ projects, these may change. ...@@ -56,22 +56,5 @@ projects, these may change.
Code testing Code testing
------------ ------------
Testing for :mod:`bfps` is done with ``tox``. We use CTest for testing `TurTLE`.
----------------
Work in progress
----------------
HDF5 field I/O
--------------
As you can tell from the ``todo.txt`` file, in the future the code will
use HDF5 for input/output of fields.
For now, field I/O is done with binary files, and the field data type is
stored in the parameter file.
Code flexibility
----------------
Version 2.0 will be designed so that new fluid equations can be coded in
from python classes, rather than as new C++ files.
[tox]
envlist = py34
[testenv]
sitepackages = True
whitelist_externals =
echo
cp
passenv = LD_LIBRARY_PATH
changedir =
{envtmpdir}
commands =
cp -r {toxinidir}/tests {envtmpdir}
python tests/{posargs:DEFAULTS}
[tox]
envlist = py34
[testenv]
sitepackages = True
whitelist_externals =
echo
cp
passenv = LD_LIBRARY_PATH
changedir =
{envtmpdir}
commands =
python -m bfps {posargs:DEFAULTS}
[tox]
envlist = py34
[testenv]
sitepackages = True
whitelist_externals =
echo
cp
passenv = LD_LIBRARY_PATH
changedir =
{envtmpdir}
commands =
cp -r {toxinidir}/tests {envtmpdir}
python tests/test_io.py
python tests/test_interpolation.py
python tests/test_interpolation.py --precision double --wd "interp_double"
python tests/test_plain.py
python tests/test_plain.py --precision double --wd "data/double"
python tests/test_scaling.py
python tests/test_scaling.py --precision double --wd "data/double"
python tests/test_particles.py
python tests/test_particles.py --precision double --wd "data/double"
python tests/test_time_step.py
python tests/test_time_step.py --precision double --wd "data/double"
python tests/test_convergence.py
python tests/test_convergence.py --precision double --wd "data/double"
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment