PCMSolver can be built with Ninja

robertodr · robertodr · commit faf40d431775 · 2017-10-19T06:02:43.000+02:00
Notice that this requires at least CMake 3.7.2 and the
Kitware-maintained version of Ninja.
Other updates:
- Clean-up of source tree. CI-related stuff has been moved to the .ci
  directory
- For my convenience, I have added default.nix and .envrc to the tree.
- I have updated Autocmake.
diff --git a/.ci/Dangerfile b/.ci/Dangerfile
diff --git a/.ci/Gemfile b/.ci/Gemfile
diff --git a/.ci/Gemfile.lock b/.ci/Gemfile.lock
diff --git a/.ci/ci_build.sh b/.ci/ci_build.sh
diff --git a/.ci/ci_print_failing.py b/.ci/ci_print_failing.py
diff --git a/.ci/ci_test.py b/.ci/ci_test.py
diff --git a/.envrc b/.envrc
@@ -0,0 +1,2 @@
+use nix
+export NINJA_STATUS="[Built edge %f of %t in %e sec]"
diff --git a/.travis.yml b/.travis.yml
@@ -136,18 +136,18 @@ before_script:
 - ${Fortran_COMPILER} --version
 - |
   if [[ "${RUN_DANGER}" = true ]]; then
-    bundle install
+    bundle install --gemfile=.ci/Gemfile
   fi
 script:
 - |
   if [[ "${RUN_DANGER}" = true ]]; then
-    bundle exec danger
+    BUNDLE_GEMFILE=.ci/Gemfile bundle exec danger --dangerfile=.ci/Dangerfile
   fi
 - python setup.py --cxx=${CXX_COMPILER} --cc=${C_COMPILER} --fc=${Fortran_COMPILER} --type=${BUILD_TYPE} --cmake-options='-Hprojects/CMake' ${STATIC} ${COVERAGE}
 - cd build
-- ../.scripts/ci_build.sh
-- python ../.scripts/ci_test.py ctest --output-on-failure --verbose
-- python ../.scripts/ci_print_failing.py
+- ../.ci/ci_build.sh
+- python ../.ci/ci_test.py ctest --output-on-failure --verbose
+- python ../.ci/ci_print_failing.py
 after_success:
 - |
   if [[ "${COVERAGE}" = true ]]; then
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,10 @@
   This can be an additional source of electrostatic potential for the calculation
   of the ASC.
 - Restored compilation for g++ < v5.1.
+- [Ninja](https://ninja-build.org/) can be used as a generator.
+  Notice that at least [CMake 3.7.2](https://cmake.org/cmake/help/v3.7/generator/Ninja.html#fortran-support)
+  **and** the [Kitware-maintained](https://github.com/Kitware/ninja) version of
+  Ninja are required to successfully compile.
 
 ### Changed
 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 2.8.10 FATAL_ERROR)
 
 # project name
-project(PCMSolver)
+project(PCMSolver CXX C Fortran)
 
 # do not rebuild if rules (compiler flags) change
 set(CMAKE_SKIP_RULE_DEPENDENCY TRUE)
diff --git a/cmake/autocmake.yml b/cmake/autocmake.yml
@@ -3,6 +3,10 @@ min_cmake_version: 2.8.10
 setup_script: setup.py
 url_root: https://github.com/coderefinery/autocmake/raw/master/
 default_build_type: debug
+language:
+  - CXX
+  - C
+  - Fortran
 
 modules:
   - compilers:
diff --git a/cmake/autocmake/configure.py b/cmake/autocmake/configure.py
@@ -98,8 +98,10 @@ def run_cmake(command, build_path, default_build_path):
     print(stdout)
 
     if stderr:
+        # we write out stderr but we do not stop yet
+        # this is because CMake warnings are sent to stderr
+        # and they might be benign
         sys.stderr.write(stderr)
-        sys.exit(1)
 
     # write cmake output to file
     with open('cmake_output', 'w') as f:
@@ -108,16 +110,21 @@ def run_cmake(command, build_path, default_build_path):
     # change directory and return
     os.chdir(topdir)
 
-    if 'Configuring incomplete' in stdout:
-        # configuration was not successful
+    # to figure out whether configuration was a success
+    # we check for 3 sentences that should be part of stdout
+    configuring_done = '-- Configuring done' in stdout
+    generating_done = '-- Generating done' in stdout
+    build_files_written = '-- Build files have been written to' in stdout
+    configuration_successful = configuring_done and generating_done and build_files_written
+
+    if configuration_successful:
+        save_setup_command(sys.argv, build_path)
+        print_build_help(build_path, default_build_path)
+    else:
         if (build_path == default_build_path):
             # remove build_path iff not set by the user
             # otherwise removal can be dangerous
             rmtree(default_build_path)
-    else:
-        # configuration was successful
-        save_setup_command(sys.argv, build_path)
-        print_build_help(build_path, default_build_path)
 
 
 def print_build_help(build_path, default_build_path):
diff --git a/cmake/autocmake/generate.py b/cmake/autocmake/generate.py
@@ -56,7 +56,7 @@ def gen_setup(config, default_build_type, relative_path, setup_script_name):
     s.append('\n{0}'.format(autogenerated_notice()))
     s.append('\nimport os')
     s.append('import sys')
-    s.append('assert sys.version_info >= (2, 6), \'Python >= 2.6 is required\' ')
+    s.append('assert sys.version_info >= (2, 6), \'Python >= 2.6 is required\'')
 
     s.append("\nsys.path.insert(0, '{0}')".format(relative_path))
 
@@ -118,7 +118,7 @@ def gen_setup(config, default_build_type, relative_path, setup_script_name):
     return s
 
 
-def gen_cmakelists(project_name, min_cmake_version, default_build_type, relative_path, modules):
+def gen_cmakelists(project_name, project_language, min_cmake_version, default_build_type, relative_path, modules):
     """
     Generate CMakeLists.txt.
     """
@@ -132,7 +132,7 @@ def gen_cmakelists(project_name, min_cmake_version, default_build_type, relative
     s.append('cmake_minimum_required(VERSION {0} FATAL_ERROR)'.format(min_cmake_version))
 
     s.append('\n# project name')
-    s.append('project({0})'.format(project_name))
+    s.append('project({0} {1})'.format(project_name, project_language))
 
     s.append('\n# do not rebuild if rules (compiler flags) change')
     s.append('set(CMAKE_SKIP_RULE_DEPENDENCY TRUE)')
diff --git a/cmake/downloaded/autocmake_cc.cmake b/cmake/downloaded/autocmake_cc.cmake
@@ -25,8 +25,6 @@
 #   export: "'CC={0}'.format(arguments['--cc'])"
 #   define: "'-DEXTRA_CFLAGS=\"{0}\"'.format(arguments['--extra-cc-flags'])"
 
-enable_language(C)
-
 if(NOT DEFINED CMAKE_C_COMPILER_ID)
     message(FATAL_ERROR "CMAKE_C_COMPILER_ID variable is not defined!")
 endif()
@@ -36,7 +34,9 @@ if(NOT CMAKE_C_COMPILER_WORKS)
 endif()
 
 if(DEFINED EXTRA_CFLAGS)
+  if(NOT EXTRA_CFLAGS STREQUAL "")
     set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${EXTRA_CFLAGS}")
+  endif()
 endif()
 
 if(DEFINED ENV{CFLAGS})
diff --git a/cmake/downloaded/autocmake_cxx.cmake b/cmake/downloaded/autocmake_cxx.cmake
@@ -25,18 +25,18 @@
 #   export: "'CXX={0}'.format(arguments['--cxx'])"
 #   define: "'-DEXTRA_CXXFLAGS=\"{0}\"'.format(arguments['--extra-cxx-flags'])"
 
-enable_language(CXX)
-
-if(NOT DEFINED CMAKE_C_COMPILER_ID)
-    message(FATAL_ERROR "CMAKE_C_COMPILER_ID variable is not defined!")
+if(NOT DEFINED CMAKE_CXX_COMPILER_ID)
+    message(FATAL_ERROR "CMAKE_CXX_COMPILER_ID variable is not defined!")
 endif()
 
-if(NOT CMAKE_C_COMPILER_WORKS)
-    message(FATAL_ERROR "CMAKE_C_COMPILER_WORKS is false!")
+if(NOT CMAKE_CXX_COMPILER_WORKS)
+    message(FATAL_ERROR "CMAKE_CXX_COMPILER_WORKS is false!")
 endif()
 
 if(DEFINED EXTRA_CXXFLAGS)
+  if(NOT EXTRA_CXXFLAGS STREQUAL "")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${EXTRA_CXXFLAGS}")
+  endif()
 endif()
 
 if(DEFINED ENV{CXXFLAGS})
diff --git a/cmake/downloaded/autocmake_fc.cmake b/cmake/downloaded/autocmake_fc.cmake
@@ -29,8 +29,6 @@
 #   export: "'FC={0}'.format(arguments['--fc'])"
 #   define: "'-DEXTRA_FCFLAGS=\"{0}\"'.format(arguments['--extra-fc-flags'])"
 
-enable_language(Fortran)
-
 set(CMAKE_Fortran_MODULE_DIRECTORY ${PROJECT_BINARY_DIR}/modules)
 include_directories(${PROJECT_BINARY_DIR}/modules)
 
@@ -43,7 +41,9 @@ if(NOT CMAKE_Fortran_COMPILER_WORKS)
 endif()
 
 if(DEFINED EXTRA_FCFLAGS)
+  if(NOT EXTRA_FCFLAGS STREQUAL "")
     set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} ${EXTRA_FCFLAGS}")
+  endif()
 endif()
 
 if(DEFINED ENV{FCFLAGS})
diff --git a/cmake/update.py b/cmake/update.py
@@ -141,6 +141,14 @@ def process_yaml(argv):
         sys.stderr.write("ERROR: project name contains a space\n")
         sys.exit(-1)
 
+    if 'language' in config:
+        project_language = ' '.join(config['language']) if isinstance(config['language'], list) else config['language']
+    else:
+        sys.stderr.write("ERROR: you have to specify the project language(s) in autocmake.yml\n\n")
+        sys.stderr.write("# for instance like this (several languages):\nlanguage:\n  - CXX\n  - Fortran\n\n")
+        sys.stderr.write("# or like this (one language):\nlanguage: Fortran\n\n")
+        sys.exit(-1)
+
     if 'min_cmake_version' in config:
         min_cmake_version = config['min_cmake_version']
     else:
@@ -150,7 +158,8 @@ def process_yaml(argv):
     if 'default_build_type' in config:
         default_build_type = config['default_build_type'].lower()
     else:
-        sys.stderr.write("ERROR: you have to specify default_build_type in autocmake.yml\n")
+        sys.stderr.write("ERROR: you have to specify default_build_type in autocmake.yml\n\n")
+        sys.stderr.write("# for instance like this (debug, release, relwithdebinfo, or minsizerel):\ndefault_build_type: release\n\n")
         sys.exit(-1)
 
     if 'setup_script' in config:
@@ -179,18 +188,19 @@ def process_yaml(argv):
 
     # create CMakeLists.txt
     print('- generating CMakeLists.txt')
-    s = gen_cmakelists(project_name, min_cmake_version, default_build_type, relative_path, modules)
+    s = gen_cmakelists(project_name, project_language, min_cmake_version, default_build_type, relative_path, modules)
     with open(os.path.join(project_root, 'CMakeLists.txt'), 'w') as f:
         f.write('{0}\n'.format('\n'.join(s)))
 
-    # create setup script
-    print('- generating setup script')
-    s = gen_setup(cleaned_config, default_build_type, relative_path, setup_script_name)
-    file_path = os.path.join(project_root, setup_script_name)
-    with open(file_path, 'w') as f:
-        f.write('{0}\n'.format('\n'.join(s)))
-    if sys.platform != 'win32':
-        make_executable(file_path)
+    # create setup script unless it is 'None' or 'none'
+    if setup_script_name.lower() != 'none':
+        print('- generating setup script')
+        s = gen_setup(cleaned_config, default_build_type, relative_path, setup_script_name)
+        file_path = os.path.join(project_root, setup_script_name)
+        with open(file_path, 'w') as f:
+            f.write('{0}\n'.format('\n'.join(s)))
+        if sys.platform != 'win32':
+            make_executable(file_path)
 
 
 def main(argv):
diff --git a/default.nix b/default.nix
@@ -0,0 +1,32 @@
+with import <nixpkgs> {}; {
+  pcmEnv = stdenv.mkDerivation {
+    name = "PCMSolver";
+    buildInputs = [
+      boost
+      bundler
+      ccache
+      clang
+      clang-analyzer
+      clang-tools
+      cmake
+      doxygen
+      gcc
+      gdb
+      gfortran
+      lldb
+      openmpi
+      python35Packages.breathe
+      python35Packages.jupyter
+      python35Packages.matplotlib
+      python35Packages.numpy
+      python35Packages.pyyaml
+      python35Packages.recommonmark
+      python35Packages.scipy
+      python35Packages.sphinx
+      python35Packages.sphinx_rtd_theme
+      python35Packages.sympy
+      valgrind
+      zlib
+    ];
+  };
+}
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 import os
 import sys
-assert sys.version_info >= (2, 6), 'Python >= 2.6 is required' 
+assert sys.version_info >= (2, 6), 'Python >= 2.6 is required'
 
 sys.path.insert(0, 'cmake')
 from autocmake import configure
diff --git a/src/green/CMakeLists.txt b/src/green/CMakeLists.txt
@@ -7,6 +7,7 @@ list(APPEND headers_list Green.hpp AnisotropicLiquid.hpp DerivativeTypes.hpp Der
 # List of sources
 list(APPEND sources_list Vacuum.cpp UniformDielectric.cpp IonicLiquid.cpp AnisotropicLiquid.cpp SphericalDiffuse.cpp)
 
+include_directories(dielectric_profile)
 add_library(green OBJECT ${sources_list} ${headers_list})
 set_target_properties(green PROPERTIES POSITION_INDEPENDENT_CODE 1 )
 add_dependencies(green generate-config-hpp)
diff --git a/src/green/dielectric_profile/CMakeLists.txt b/src/green/dielectric_profile/CMakeLists.txt
@@ -1,13 +1,6 @@
 # List of headers
 list(APPEND _headers_list Anisotropic.hpp MembraneTanh.hpp Metal.hpp OneLayerErf.hpp OneLayerTanh.hpp ProfileTypes.hpp Sharp.hpp Uniform.hpp Yukawa.hpp)
 
-# List of sources
-list(APPEND _sources_list )
-
-add_library(dielectric_profile OBJECT ${_headers_list} ${_sources_list})
-set_target_properties(dielectric_profile PROPERTIES POSITION_INDEPENDENT_CODE 1 )
-add_dependencies(dielectric_profile generate-config-hpp)
-target_compile_options(dielectric_profile PRIVATE "$<$<CONFIG:DEBUG>:${EXDIAG_CXX_FLAGS}>")
 # Sets install directory for all the headers in the list
 foreach(_header ${_headers_list})
     install(FILES ${_header} DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}/green/dielectric_profile)

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+use nix`
	`2`	`+export NINJA_STATUS="[Built edge %f of %t in %e sec]"`