LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-11-18 12:03:50 +01:00
Code Issues Releases Wiki Activity

[doc] install and first page + github logo

Browse Source
This commit is contained in:
Hugo U. R. Strand 2019-04-24 15:19:25 -04:00 committed by Nils Wentzell
parent a113230ffe
commit 171dbcdecf
4 changed files with 16 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/_static/logo_github.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

2
doc/_templates/sideb.html vendored
View File

@ -10,5 +10,5 @@
</p> </p>
<hr> <hr>
<p> <p>
<a href="https://github.com/triqs/app4triqs"> <img style="width: 50px; margin: 10px 0 0 5px" src='https://assets-cdn.github.com/images/modules/logos_page/GitHub-Mark.png' alt="Visit the project on GitHub"/> </a> <a href="https://github.com/triqs/tprf"> <img style="width: 200px; margin: 10px 0 0 5px" src='_static/logo_github.png' alt="Visit the project on GitHub"/> </a>
</p> </p>

8
doc/index.rst
View File

@ -3,12 +3,12 @@
app4triqs app4triqs
========= =========
.. sidebar:: app4triqs 2.2 .. sidebar:: app4triqs 2.2.0
This is the homepage app4triqs Version 2.2 This is the homepage of app4triqs v2.2.0.
For changes see, Cf :ref:`changelog page <changelog>` For changes see the :ref:`changelog page <changelog>`.
An example application using cpp2py and triqs. An example application using cpp2py and TRIQS.
This documentation is generated based on `rst <https://de.wikipedia.org/wiki/ReStructuredText>`_ files This documentation is generated based on `rst <https://de.wikipedia.org/wiki/ReStructuredText>`_ files
and the comments in the sources and headers. and the comments in the sources and headers.

24
doc/install.rst
View File

@ -2,15 +2,15 @@
.. _install: .. _install:
Compiling AP4TRIQS from source Compiling app4triqs from source
============================== ===================================
Prerequisite Prerequisites
------------------- -------------
#. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:installation>`. #. The :ref:`TRIQS <triqslibs:welcome>` library, see :ref:`TRIQS installation instruction <triqslibs:installation>`.
In the following, we assume that Triqs is installed in the ``path_to_triqs`` directory. In the following, we assume that TRIQS is installed in the directory ``path_to_triqs``.
Installation steps Installation steps
------------------ ------------------
@ -40,12 +40,10 @@ Installation steps
Version compatibility Version compatibility
--------------------- ---------------------
Be careful that the version of the TRIQS library and of the application must be Keep in mind that the version of ``app4triqs`` must be compatible with your TRIQS library version,
compatible (more information on the :ref:`TRIQS website <triqslibs:versions>`). see :ref:`TRIQS website <triqslibs:versions>`.
In particular you should make sure that the Major and Minor Version number In particular the Major and Minor Version numbers have to be the same.
of the application and TRIQS agree. To use a particular version, go into the directory with the sources, and look at all available versions::
If you want to use a particular version of the application, go into the directory with the sources
and look at all available versions::
$ cd app4triqs.src && git tag $ cd app4triqs.src && git tag
@ -53,12 +51,12 @@ Checkout the version of the code that you want::
$ git checkout 2.1.0 $ git checkout 2.1.0
Then follow the steps 2 to 4 described above to compile the code. and follow steps 2 to 4 above to compile the code.
Custom CMake options Custom CMake options
-------------------- --------------------
Functionality of ``app4triqs`` can be tweaked using extra compile-time options passed to CMake:: The compilation of ``app4triqs`` can be configured using CMake-options::
cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ... ../app4triqs.src cmake ../app4triqs.src -DOPTION1=value1 -DOPTION2=value2 ... ../app4triqs.src