Skip to content

gitter-badger/solvcon

Repository files navigation

SOLVCON is a collection of conservation-law solvers that use the space-time Conservation Element and Solution Element (CESE) method.

Install

Clone from https://bitbucket.org/solvcon/solvcon:

$ hg clone https://bitbucket.org/solvcon/solvcon

SOLVCON needs the following packages: gcc 4.3+ (clang on OSX works as well), Python 2.7/3.4, six 1.10.0, Cython 0.16+, Numpy 1.5+, LAPACK, NetCDF 4+, SCOTCH 6.0+, Nose 1.0+, Paramiko 1.14+, boto 2.29.1+, gmsh 2.5+, and VTK 5.6+.

A script at contrib/conda.sh is provided to install the dependency with Anaconda.

The following command builds and installs SOLVCON:

$ python setup.py install

After installed you can run the unit tests:

$ python -c 'import solvcon as sc; sc.test()'

Additional build and tests:

  • Building document requires Sphinx 1.3.1+, pstake 0.3.4+, Sphinxcontrib issue tracker 0.11, and graphviz 2.28+. Once the binary of SOLVCON is built, the following commands can build the document:

    $ cd doc
    $ make html

    The built document will be available at doc/build/html/.

  • When building SOLVCON locally:

    $ python setup.py build_ext --inplace

    You can run unit tests with Nose:

    $ nosetests
  • Another set of tests are collected in ftests/ directory, and can be run with:

    $ nosetests ftests/*

    Some tests in ftests/ involve remote procedure call (RPC) that uses ssh. You need to set up the public key authentication to properly run them.