README.txt 2.17 KB
Newer Older
BRAMAS Berenger's avatar
BRAMAS Berenger committed
1 2 3 4

ScalFmm, Inria, Please read the licence.

---------------------------------------------------
BRAMAS Berenger's avatar
BRAMAS Berenger committed
5 6 7 8
---------------------------------------------------

To compile:
==========
BRAMAS Berenger's avatar
BRAMAS Berenger committed
9 10 11 12 13 14 15
# Go to 
cd scalfmm/Build
# Use cmake first by
cmake ..
# Or if you want to use MPI
cmake .. -DScalFMM_USE_MPI=ON

PIACIBELLO Cyrille's avatar
PIACIBELLO Cyrille committed
16

BRAMAS Berenger's avatar
BRAMAS Berenger committed
17 18 19 20 21 22 23 24 25
# Configure, for example with:
ccmake ..
# turn on/off the options you want
# For example, it is advised to build the tests and have a look in scalfmm/Tests/
# Finally you can build by
make
# And access executables in scalfmm/Build/Tests/{Release,Debug}/.....

---------------------------------------------------
BRAMAS Berenger's avatar
BRAMAS Berenger committed
26 27 28 29
---------------------------------------------------

Build the doc:
=============
BRAMAS Berenger's avatar
BRAMAS Berenger committed
30 31 32 33 34 35 36 37 38
In scalfmm/Doc you can find several pdf and .tex file about
the implementation, kernels and data structure.

# The developer documentation is generated using DOxygen: 
cd scalfmm/Build
# Tape 
make doc
# This will create a Html dir
browser scalfmm/Build/Doc/html/index.html
39 40


BRAMAS Berenger's avatar
BRAMAS Berenger committed
41 42 43 44 45 46 47 48 49
---------------------------------------------------
---------------------------------------------------

Getting help and having news from us:
====================================

You can subscribe to the scalfmm users mailing list ( scalfmm-public-users@lists.gforge.inria.fr,  http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users ). Very low trafic (~ 2 mails per year) just to know when a news version or an improvement is available.

Contact the developers at : scalfmm-public-support@lists.gforge.inria.fr
BRAMAS Berenger's avatar
BRAMAS Berenger committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65


---------------------------------------------------
---------------------------------------------------

What inside :
=============
× Src : The Core of Scalfmm is under the Src directory. Users should not need to modify the source.
One can want to implement its own kernel or even its own parallelization whithout modifying the sources.
× Data : example of particles distributions
× Examples : examples of very common usage of Scalfmm
× Doc : should contains the generated Doc
× UTests : contains some unit tests (it can be a good example to understand some features)
× Tests : examples to know how to use scalfmm/put particles in the tree/iterate on the tree...
× Utils : some scripts to work with the data files.