mirror of
https://github.com/triqs/dft_tools
synced 2024-12-27 06:43:40 +01:00
edd1ff4529
A first general restructuration of the doc according to the pattern [tour|tutorial|reference]. In the reference part, objects are documented per topic. In each topic, [definition|c++|python|hdf5] (not yet implemented)
92 lines
2.9 KiB
ReStructuredText
92 lines
2.9 KiB
ReStructuredText
.. highlight:: c
|
|
|
|
Writing you own C++ code with TRIQS
|
|
------------------------------------
|
|
|
|
Basically, this structure means that you have successfully installed TRIQS in
|
|
:file:`/home/triqs/install` and that you plan to have your new project under
|
|
:file:`/home/project`. Obviously you can choose any other directory but this
|
|
structure will be assumed below.
|
|
|
|
.. code-block :: bash
|
|
|
|
/home/triqs/install --> TRIQS is installed here
|
|
/home/project/src --> the sources of my project
|
|
/home/project/build --> the directory where I will compile my code
|
|
|
|
As we just said, we will start our project in a directory
|
|
:file:`/home/project`. We will have the sources in :file:`/home/project/src`
|
|
and later build (compile) the project in :file:`/home/project/build`. Let's
|
|
start by writing some sources:
|
|
|
|
.. code-block :: bash
|
|
|
|
$ cd /home
|
|
$ mkdir project
|
|
$ cd project
|
|
$ mkdir src
|
|
$ cd src
|
|
|
|
OK, our project will be just one :file:`main.cpp` file, e.g.::
|
|
|
|
#include <triqs/arrays.hpp>
|
|
using namespace triqs::arrays;
|
|
int main(){
|
|
array<double,1> A {1,2,3}, B{10,20,30}, C;
|
|
C = A+B;
|
|
std::cout << "C = "<< C << std::endl;
|
|
}
|
|
|
|
As you can see, the code includes headers from TRIQS. Along with
|
|
:file:`main.cpp` we write a :file:`CMakeLists.txt` file to compile our project.
|
|
In order to make this easy, there is a file called :file:`TRIQSConfig.cmake`
|
|
in :file:`/home/triqs/install/share/triqs/cmake`. Including this file in
|
|
your :file:`CMakeLists.txt` automatically defines a certain number of useful
|
|
variables, especially the include directories related to the TRIQS headers and
|
|
the location of the TRIQS libraries. Here is what your simple
|
|
:file:`CMakeLists.txt` can be:
|
|
|
|
.. code-block :: cmake
|
|
|
|
# Append triqs installed files to the cmake load path
|
|
list(APPEND CMAKE_MODULE_PATH ${TRIQS_PATH}/share/triqs/cmake)
|
|
|
|
# Start configuration
|
|
cmake_minimum_required(VERSION 2.8)
|
|
project(myproj CXX)
|
|
set(CMAKE_BUILD_TYPE Release)
|
|
|
|
# Load TRIQS, including all predefined variables from TRIQS installation
|
|
find_package(TRIQS REQUIRED)
|
|
|
|
# Linking and include info
|
|
link_libraries(${TRIQS_LIBRARY_ALL})
|
|
include_directories(${TRIQS_INCLUDE_ALL})
|
|
|
|
# Create executable
|
|
add_executable(example main.cpp)
|
|
triqs_set_rpath_for_target(example)
|
|
|
|
We're all set! Everything is ready to compile our project. If we want to build
|
|
everything in :file:`/home/project/build`, we do as follows:
|
|
|
|
.. code-block :: bash
|
|
|
|
$ cd /home/project
|
|
$ mkdir build
|
|
$ cd build
|
|
$ cmake -DTRIQS_PATH=/home/triqs/install /home/project/src
|
|
$ make
|
|
$ ./example
|
|
|
|
That's it! You can modify your sources and then recompile with make. Obviously
|
|
with bigger projects your :file:`CMakeLists.txt` file will change, but the
|
|
principle remains the same.
|
|
|
|
A simple C++ project, with its tests and documentation
|
|
------------------------------------------------------
|
|
|
|
A mixed C++/Python project
|
|
------------------------------
|
|
|