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
|
# The SC Library
This is the `README` file for `libsc`.
The SC Library provides support for parallel scientific applications.
Copyright (C) 2010 The University of Texas System
Additional copyright (C) 2011 individual authors
`libsc` is written by Carsten Burstedde, Lucas C. Wilcox, Tobin Isaac, and
others. `libsc` is free software released under the GNU Lesser General
Public Licence version 2.1 (or, at your option, any later version).
The official web page for source code and documentation is
[p4est.org](https://www.p4est.org/).
Please send bug reports and ideas for contribution to `p4est@ins.uni-bonn.de`.
You are also welcome to post issues on
[github](https://www.github.com/cburstedde/libsc.git).
Please see the `CONTRIBUTING` file and
our [coding standards](doc/coding_standards.txt) for details.
## Building `libsc`
The build instructions for `p4est` also apply to standalone builds of `libsc`.
### Autotools
The autotools build chain is fully supported.
In a fresh checkout, you may run `./bootstrap` to create the `configure`
script. Calling `make` will regenerate the tools configuration as needed.
Only in rare cases `./bootstrap` will have to be run again. The script depends
on existing `autoconf`, `automake`, `libtool` and `pkg-config` tools.
Calling `bootstrap` is *not* required for unpacked `tar` archives, or after
pulling fresh code.
We recommend running `configure` with a relative path from an empty build
directory. Try
configure --help
for options and switches. For development with MPI:
cd empty/build/directory
../relative/path/to/configure --enable-mpi --enable-debug \
CFLAGS="-O0 -g -Wall -Wextra -Wno-unused-parameter"
make -j8 V=0
To run tests in parallel, run
make -j2 check V=0
and to pack a distribution tarball, call `bootstrap` and
mkdir -p build && cd build && ../configure
make -j3 distcheck V=0
The `V=0` environment variable significantly unclutters console output.
So far, we have not made `V=0` the default.
|