Create a python-only version of the app4triqs skeleton

Author: Wentzell

CMakeLists.txt

@@ -59,38 +59,6 @@ if(NOT CMAKE_BUILD_TYPE)
 endif()
 message(STATUS "-------- BUILD-TYPE: ${CMAKE_BUILD_TYPE} --------")
 
-# Build static libraries
-set(BUILD_SHARED_LIBS OFF)
-
-# Export the list of compile-commands into compile_commands.json
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-
-# Global compiler options
-add_compile_options(
-  $<$<CONFIG:Debug>:-Og>
-  $<$<CONFIG:Debug>:-ggdb3>
-)
-
-# Create an Interface target for compiler warnings
-add_library(project_warnings INTERFACE)
-install(TARGETS project_warnings EXPORT app4triqs-targets)
-target_compile_options(project_warnings
-  INTERFACE
-    -Wall
-    -Wextra
-    -Wpedantic
-    -Wno-sign-compare
-    $<$<CXX_COMPILER_ID:GNU>:-Wshadow=local>
-    $<$<CXX_COMPILER_ID:Clang>:-Wshadow>
-    $<$<CXX_COMPILER_ID:Clang>:-Wno-gcc-compat>
-)
-
-# #############
-# Build Project
-
-# Build and install the app4triqs library
-add_subdirectory(c++/app4triqs)
-
 # Tests
 option(Build_Tests "Build tests" ON)
 if(Build_Tests)

README.md

@@ -12,7 +12,7 @@ To adapt this skeleton for a new TRIQS application, the following steps are nece
 * Run the following commands in order after replacing **appname** accordingly
 
 ```bash
-git clone https://github.com/triqs/app4triqs --branch unstable appname
+git clone https://github.com/triqs/app4triqs --branch python_only appname
 cd appname
 ./share/squash_history.sh
 ./share/replace_and_rename.sh appname
@@ -36,7 +36,7 @@ You can merge future changes to the app4triqs skeleton into your project with th
 
 ```bash
 git remote update
-git merge app4triqs_remote/unstable -m "Merge latest app4triqs skeleton changes"
+git merge app4triqs_remote/python_only -m "Merge latest app4triqs skeleton changes"
 ```
 
 If you should encounter any conflicts resolve them and `git commit`.
@@ -54,10 +54,7 @@ After setting up your application as described above you should customize the fo
 according to your needs (replace app4triqs in the following by the name of your application)
 
 * Adjust or remove the `README.md` and `doc/ChangeLog.md` file
-* In the `c++/app4triqs` subdirectory adjust the example files `app4triqs.hpp` and `app4triqs.cpp` or add your own source files.
-* In the `test/c++` subdirectory adjust the example test `basic.cpp` or add your own tests.
 * In the `python/app4triqs` subdirectory add your Python source files.
-  Be sure to remove the `app4triqs_module_desc.py` file unless you want to generate a Python module from your C++ source code.
 * In the `test/python` subdirectory adjust the example test `Basic.py` or add your own tests.
 * Adjust any documentation examples given as `*.rst` files in the doc directory.
 * Adjust the sphinx configuration in `doc/conf.py.in` as necessary.
@@ -66,10 +63,6 @@ according to your needs (replace app4triqs in the following by the name of your
 ### Optional ###
 ----------------
 
-* If you want to wrap C++ classes and/or functions provided in the `c++/app4triqs/app4triqs.hpp` rerun the `c++2py` tool with
-```bash
-c++2py -r app4triqs_module_desc.py
-```
 * Add your email address to the bottom section of `Jenkinsfile` for Jenkins CI notification emails
 ```
 End of build log:

c++/app4triqs/CMakeLists.txt

@@ -1,48 +1,6 @@
 # Generate the sphinx config file
 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in ${CMAKE_CURRENT_BINARY_DIR}/conf.py @ONLY)
 
-# -----------------------------------------------------------------------------
-# Create an optional target that allows us to regenerate the C++ doc with c++2rst
-# -----------------------------------------------------------------------------
-add_custom_target(docs_cpp2rst)
-include(${PROJECT_SOURCE_DIR}/share/cmake/extract_flags.cmake)
-extract_flags(app4triqs_c)
-separate_arguments(app4triqs_c_CXXFLAGS)
-macro(generate_docs header_file)
-  add_custom_command(
-    TARGET docs_cpp2rst
-    COMMAND rm -rf ${CMAKE_CURRENT_SOURCE_DIR}/cpp2rst_generated
-    COMMAND
-      c++2rst
-      ${header_file}
-      -N app4triqs
-      --output_directory ${CMAKE_CURRENT_SOURCE_DIR}/cpp2rst_generated
-      -I${PROJECT_SOURCE_DIR}/c++
-      --cxxflags="${app4triqs_c_CXXFLAGS}"
-  )
-endmacro(generate_docs)
-
-generate_docs(${PROJECT_SOURCE_DIR}/c++/app4triqs/app4triqs.hpp)
-
-# --------------------------------------------------------
-# Build & Run the C++ doc examples and capture the output
-# --------------------------------------------------------
-
-add_custom_target(docs_example_output)
-file(GLOB_RECURSE ExampleList RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.cpp)
-foreach(example ${ExampleList})
-  get_filename_component(f ${example} NAME_WE)
-  get_filename_component(d ${example} DIRECTORY)
-  add_executable(doc_${f} EXCLUDE_FROM_ALL ${example})
-  set_property(TARGET doc_${f} PROPERTY RUNTIME_OUTPUT_DIRECTORY ${d})
-  target_link_libraries(doc_${f} triqs)
-  add_custom_command(TARGET doc_${f}
-   COMMAND doc_${f} > ${CMAKE_CURRENT_SOURCE_DIR}/${d}/${f}.output 2>/dev/null
-   WORKING_DIRECTORY ${d}
-  )
-  add_dependencies(docs_example_output doc_${f})
-endforeach()
-
 # ---------------------------------
 # Top Sphinx target
 # ---------------------------------
@@ -53,16 +11,6 @@ add_custom_command(
   COMMAND PYTHONPATH=${CMAKE_BINARY_DIR}/python:$ENV{PYTHONPATH} ${TRIQS_SPHINXBUILD_EXECUTABLE} -c . -j8 -b html ${CMAKE_CURRENT_SOURCE_DIR} html
 )
 
-option(Sphinx_Only "When building the documentation, skip the Python Modules and the generation of C++ Api and example outputs" OFF)
-if(NOT Sphinx_Only)
-  # Autodoc usage requires the python modules to be built first
-  get_property(CPP2PY_MODULES_LIST GLOBAL PROPERTY CPP2PY_MODULES_LIST)
-  add_dependencies(docs_sphinx ${CPP2PY_MODULES_LIST})
-
-  # Generation of C++ Api and Example Outputs
-  add_dependencies(docs_sphinx docs_cpp2rst docs_example_output)
-endif()
-
 # ---------------------------------
 # Install
 # ---------------------------------

c++/app4triqs/app4triqs.cpp

@@ -21,14 +21,6 @@ Table of Contents
    changelog
    about
 
-C++ reference manual
---------------------
-
-.. toctree::
-   :maxdepth: 5
-
-   cpp2rst_generated/contents
-
 Python reference manual
 -----------------------
 

c++/app4triqs/app4triqs.hpp

@@ -33,7 +33,6 @@ Installation steps
 
 #. Compile the code, run the tests and install the application::
 
-     $ make
      $ make test
      $ make install
 

doc/CMakeLists.txt

@@ -3,21 +3,10 @@ configure_file(version.py.in version.py)
 
 # All Python files. Copy them in the build dir to have a complete package for the tests.
 file(GLOB_RECURSE python_sources RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.py)
-file(GLOB_RECURSE wrap_generators RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *_desc.py)
-list(REMOVE_ITEM python_sources "${wrap_generators}")
 foreach(file ${python_sources})
   configure_file(${file} ${file} COPYONLY)
 endforeach()
 
-# Build any python modules
-foreach(gen ${wrap_generators})
-  string(REPLACE "_desc.py" "" module_name ${gen})
-  add_cpp2py_module(${module_name})
-  target_link_libraries(${module_name} app4triqs_c)
-endforeach()
-
 # Install python modules to proper location
 set(PYTHON_LIB_DEST ${TRIQS_PYTHON_LIB_DEST_ROOT}/app4triqs)
-get_property(CPP2PY_MODULES_LIST GLOBAL PROPERTY CPP2PY_MODULES_LIST)
-install(TARGETS ${CPP2PY_MODULES_LIST} DESTINATION ${PYTHON_LIB_DEST})
 install(FILES ${python_sources} ${CMAKE_CURRENT_BINARY_DIR}/version.py DESTINATION ${PYTHON_LIB_DEST})

doc/documentation.rst

@@ -25,6 +25,4 @@
 DOC
 
 """
-from app4triqs_module import Toto, chain
-
-__all__ = ['Toto', 'chain']
+__all__ = []