/usr/lib/python2.7/dist-packages/sfepy/INSTALL is in python-sfepy 2016.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | This text contains short installation instructions for SfePy. The full
instructions are given in doc/installation.rst, see also [1, 2].
[1] http://sfepy.org
[2] http://sfepy.org/doc-devel/installation.html
Platforms
---------
*SfePy* is known to work on various flavours of Linux, on Intel Macs and
Windows.
Requirements
------------
Installation prerequisites, required to build SfePy:
- a C compiler suite (for example gcc)
- Python 2.6 or 2.7
- NumPy
- Cython
Python packages required for using SfePy:
- Pyparsing
- SciPy
- scikit-umfpack, for enabling UMFPACK solver for SciPy >= 0.14.0
- Matplotlib, for various plots; GTKAgg for live plotting via log.py
- PyTables, for storing results in HDF5 files
- SymPy, for some tests and functions
- Mayavi, for postproc.py
- Pysparse, for schroedinger.py
- igakit, for script/gen_iga_patch.py - simple IGA domain generator
- petsc4py and mpi4py, for running parallel examples and using parallel
solvers from PETSc
- pymetis, for mesh partitioning using Metis
Make sure the dependencies of those packages are also installed -
scikit-umfpack does not work without UMFPACK, petsc4py without PETSc, etc.
Other dependencies:
- To be able to (re)generate the documentation: Sphinx, numpydoc, LaTeX.
- Mesh generation tools use pexpect and gmsh or tetgen.
- IPython is preferred over the regular Python shell for following some
parts of primer/tutorial.
SfePy can be used in-place without any installation by running the scripts from
the top-level directory of the distribution (TOPDIR), or can be installed
locally or system-wide.
Compilation of C Extension Modules
----------------------------------
1. Look at ``site_cfg_template.py`` and follow the instructions
therein. Usually no changes are necessary.
2. Compile the extension modules
a) for in-place use:
python setup.py build_ext --inplace
b) for installation:
python setup.py build
Installation
------------
(As mentioned above, this step is not required to use SfePy.)
- System-wide (may require root privileges):
python setup.py install
- Local (requires write access to ``<installation prefix>``):
python setup.py install --root=<installation prefix>
Testing:
--------
Run './run_tests.py' or './run_tests.py --filter-less' in TOPDIR.
Tests that save results save them into TOPDIR/output-tests directory. View the
results (*.vtk) with a VTK-capable viewer (e.g. ParaView, Mayavi).
No failures should be reported.
If you get some failures it probably means some optional packages are not
installed. Also be sure to have a recent version of Numpy and SciPy installed
(latest releases or Git versions are the best bet). Verify also your pytables
(hdf5) installation (possible test_io.py failures).
To debug a failure, run './run_tests.py --debug'.
See also './run_tests.py --help' for further options.
Documentation:
--------------
SfePy is documented using Sphinx, see [1] above. The documentation sources are
in the doc directory.
|