diff --git a/doc/reference/c++/using_the_lib/contents.rst b/doc/reference/c++/using_the_lib/contents.rst index 557980bb..85478a2c 100644 --- a/doc/reference/c++/using_the_lib/contents.rst +++ b/doc/reference/c++/using_the_lib/contents.rst @@ -1,20 +1,15 @@ -Building an application +Using triqs in C++ =============================== The goal of these notes is to give a practical introduction to the development of a code that uses the TRIQS headers and -libraries. Rather than being completely general this tutorial will guide you -through the development of a simple CT-INT impurity solver. +libraries, including the proper `cmake` configuration files. -At first, we will see how to write a code that uses TRIQS but that is not meant -to become part of TRIQS. This is especially relevant when you write a pure C++ -code for your personal use. You will learn how to write a Monte Carlo -simulation with a simple example. +We will expose successively various cases : -The next step will be to *pythonize* your code. This is very convenient to -change parameters or do simple pre-simulation calculations. It is also -the way most of TRIQS applications are done. +.. warning:: + To be written. .. toctree:: :maxdepth: 2 diff --git a/doc/reference/c++/using_the_lib/triqs_library.rst b/doc/reference/c++/using_the_lib/triqs_library.rst index be9c7075..b1af3e5a 100644 --- a/doc/reference/c++/using_the_lib/triqs_library.rst +++ b/doc/reference/c++/using_the_lib/triqs_library.rst @@ -1,18 +1,11 @@ -Building -================== - .. highlight:: c -Let's say you want to write a new code that uses the libraries and headers of -TRIQS but that is not meant to be a part of TRIQS. Here's how you should -proceed in order to do that. - - -Setting the stage ------------------ - -Just to be clear, let me start by showing the directory structure -I will use: +A simple C++ code +-------------------- +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 @@ -20,15 +13,6 @@ I will use: /home/project/src --> the sources of my project /home/project/build --> the directory where I will compile my code -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. - - -Start your project ------------------- - 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 @@ -102,3 +86,9 @@ 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++ code, with its tests and documentation +------------------------------------------------------ + +A mixed C++/Python code +------------------------------ +