<commit_before>========================================================================
    author:              <NAME>
    filename:            INSTALL
    version:
    created:             12 July 2011
      on:                12:16:19 MDT
    last modified:   08 August 2011
      at:            15:34:23 MDT
    URL:                 http://www.ldeo.columbia.edu/~ecoon/
    email:               ecoon _at_ lanl.gov

========================================================================

INSTALL instructions for Taxila LBM

1. Install some flavor of mpi and PETSc.  See
http://www.mcs.anl.gov/petsc/petsc-as/developers/index.html

The development version of PETSc is required.  Shared libraries are
recommended for use with petsc4py, the preferred mode of loading
output for plotting Taxila LBM output in matplotlib/python.  Note that
PETSc can install MPICH2 for you automatically using the
--download-mpich option.

Recommended (quick start) configure method for PETSc:

./configure --with-shared-libararies=1 --download-mpich=1 --with-debugging=1


2. Set the environmental variable LBM_DIR to directory containing the
Taxila installation (likely the directory containing this file!)

3. Build the base objects by running ``make'' in the src/lbm directory.

4. Run a test by by running ``make test'' in one of the test
directories in $LBM_DIR/tests<commit_msg>updates INSTALL information to make sure we note what the correct PETSc to build against is.  closes #1<commit_after>Installation instructions for Taxila LBM
==================================================

Note that Taxila uses Make, and has no method for out-of-source
builds.  If you use multiple configurations (most likely a Debug
version and a Release version, as Release builds are much faster than
Debug builds but result in little help if something goes wrong),
simply download two copies of the source.

Step 1: Install PETSc and MPI
--------------------------------------------------

Install some flavor of mpi and PETSc.  See [PETSc's
website](http://www.mcs.anl.gov/petsc/) for downloads and installation
information.

Taxila attempts to stay current with the current release version of
PETSc.  Sometimes this doesn't happen too quickly, and may use an
older release.  The current version of PETSc that Taxila builds
against is:

**PETSc version 3.6**

Shared libraries are recommended for use with petsc4py, the preferred
mode of loading output for plotting Taxila LBM output in
matplotlib/python.  Note that PETSc can install MPICH2 for you
automatically using the --download-mpich option if you are building
for a small workstation without it.

Recommended (quick start) configure method for PETSc:

./configure --with-fortran-interfaces --with-shared-libraries --with-debugging --download-mpich --download-petsc4py --download-hdf5


Ensure that PETSc is installed and working, then set an environment
variable PETSC_DIR to point to your PETSc installation.


Step 2: Install Taxila LBM
--------------------------------------------------

Set the environmental variable TAXILA_DIR to the directory containing
the Taxila installation (likely the directory containing this file!)
Build the base library.

    export TAXILA_DIR=/path/to/my/taxila-lbm
    cd ${TAXILA_DIR}
    make


Step 3: Run a test
--------------------------------------------------

Run a test by by running ``make test'' in one of the test
directories in ${TAXILA_DIR}/tests
{'fraction_non_alphanumeric': 0.1535100495193708, 'fraction_numerical': 0.012525487911447713, 'mean_word_length': 3.1027479091995223, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 0, 'lorem ipsum': 0, 'www.': 3, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7672909', 'n_tokens_mistral': 933, 'n_tokens_neox': 864, 'n_words': 401}