diff --git a/doc/about.rst b/doc/about.rst index ee043a97..49ce25db 100644 --- a/doc/about.rst +++ b/doc/about.rst @@ -2,7 +2,9 @@ Authors & contributors ========================= -The TRIQS library is currrently developed by O. Parcollet (IPhT, CEA-Saclay) and M. Ferrero (CPHT, Ecole Polytechique). +The TRIQS library has been developed and is currently maintained by : + + O. Parcollet (IPhT, CEA-Saclay) and M. Ferrero (CPHT, Ecole Polytechique). It is supported by ERC under Grant Number XXX. diff --git a/doc/index.rst b/doc/index.rst index 1c7433e5..c401aaa8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -16,7 +16,7 @@ is a scientific project providing a set of C++ and Python libraries to develop n for the study of interacting quantum systems. The goal of this toolkit is to provide condensed matter physicists with -high level, efficient and simple to use libraries in C++ and Python, +some high level, efficient and simple to use libraries in C++ and Python, and to promote the use of modern programming techniques in our field. TRIQS is free software (GPL). diff --git a/doc/installation/install_options.rst b/doc/installation/install_options.rst index b836a58b..46879159 100644 --- a/doc/installation/install_options.rst +++ b/doc/installation/install_options.rst @@ -14,29 +14,17 @@ To specify the compiler with cmake one may use the CXX, CXXFLAGS variables, e.g. CXX=clang++ CXXFLAGS=XXXX cmake path_to_TRIQS_source_directory ... -Customize the installation +cmake options ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -You can then customize the installation options using the :program:`ccmake` program:: - ccmake . - -This opens an interface with your main installation options shown:: - - BUILD_SHARED_LIBS ON - Build_Documentation OFF - Build_Triqs_General_Tools_Test ON - CMAKE_INSTALL_PREFIX /home/parcolle/BUILD2/Triqs_dynamic/INSTALL_DIR - Install_dev OFF - LAPACK_LIBS /usr/lib/liblapack.so;/usr/lib/libblas.so;/usr/lib/libpthread.so;/usr/lib/libblas.so - PYTHON_INTERPRETER /usr/bin/python - -You can for instance change the following options: - -* ``CMAKE_INSTALL_PREFIX``: This is the directory :file:`path_to_install_directory` where you want to install TRIQS. -* ``Build_Documentation``: Get the documentation locally in :file:`path_to_install_directory/share/doc`. - -You may change all other installation options (like locations of libraries, the choice of compilers, etc.) in the advanced mode, by typing 't' after having opened the *ccmake* interface. - -After having corrected your options you may build, test and install TRIQS as described in :ref:`installation`. ++--------------------------------------+------------------------------------------------+ +| Options | Syntax | ++======================================+================================================+ +| Build the documentation | -DBuild_Documentation=ON | ++--------------------------------------+------------------------------------------------+ +| Special python interpreter | -DPYTHON_INTERPRETER=path/python | ++--------------------------------------+------------------------------------------------+ +| Specify the installation directory | -DCMAKE_INSTALL_PREFIX=install_path | ++--------------------------------------+------------------------------------------------+ diff --git a/doc/installation/osx_lion.rst b/doc/installation/osx_lion.rst index a1f6dd61..032b67d7 100644 --- a/doc/installation/osx_lion.rst +++ b/doc/installation/osx_lion.rst @@ -43,26 +43,6 @@ Installation of the dependencies ### brew install boost --without-single --with-mpi --with-c++11 brew install http://ipht.cea.fr/triqs/boost.rb --without-single --with-mpi --with-c++11 -v -4. Now install virtualenv: :: - - pip install virtualenv - virtualenv mypython - -Using virtualenv provides a clean way to set up a different python environment for each user. -The first line in the instructions above installs the package and the second creates the virtual -environment, which is created in ``$HOME/mypython``. -Make sure to permanently add (prepend) ``$HOME/mypython/bin`` to your path by adding :: - - export PATH = $HOME/mypython/bin:$PATH - -to your ``.bashrc file`` (assuming bash). Within a new shell, check that - - which python - which pip - which easy_install - -yield the ones located in ``$HOME/mypython``. - 5. Install the required python packages: :: pip install numpy @@ -70,14 +50,13 @@ yield the ones located in ``$HOME/mypython``. pip install scipy pip install mpi4py pip install matplotlib - # seems useless now... - #pip install git+https://github.com/matplotlib/matplotlib.git#egg=matplotlib-dev pip install tornado pip install pyzmq pip install jinja2 pip install ipython pip install cython - + # strangely, cython is not in bin, hence not in the path... + pushd /usr/local/bin && ln -s /usr/local/share/python/cython . && popd 6. If you wish to compile the documentation locally, install sphinx, its dependencies and mathjax: :: @@ -87,7 +66,6 @@ yield the ones located in ``$HOME/mypython``. NB : you need pyparsing <=1.5.7 since apparently v.2.0 works only for python 3. -7. Download the latest `sources of boost `_ and untar them into a directory ``BOOST_SRC``. Possible issues ---------------