expose version number of PartMC and pybind11 via ppmc.__versions_of_build_time_dependencies__ (#310)

Author: slayoo

CMakeLists.txt

@@ -310,6 +310,12 @@ target_include_directories(camplib PRIVATE
   ${SUNDIALS_SOURCE_DIR}/include
   ${CMAKE_BINARY_DIR}/include
 )
+file(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/include/camp)
+execute_process(
+  COMMAND ${PYTHON_EXECUTABLE} "-c" "import sys; print(''.join([line.replace(')','').replace('set(','#define ').replace('PACKAGE_', 'CAMP_') for line in sys.stdin if line.startswith('set(PACKAGE_VERSION')]))"
+  INPUT_FILE ${CMAKE_SOURCE_DIR}/gitmodules/camp/CMakeLists.txt
+  OUTPUT_FILE ${CMAKE_BINARY_DIR}/include/camp/version.h
+)
 
 ### netCDF #########################################################################################
 
@@ -428,11 +434,13 @@ string(CONCAT
   "print(''.join([f'#define {line.split()[3]} {line.split()[5]}\\n' for line in sys.stdin if 'parameter ::' in line]))"
 )
 include(CheckFunctionExists)
-execute_process(
-  COMMAND ${PYTHON_EXECUTABLE} "-c" "${cmd}"
-  INPUT_FILE ${CMAKE_SOURCE_DIR}/gitmodules/partmc/src/aero_data.F90
-  OUTPUT_FILE ${CMAKE_BINARY_DIR}/include/aero_data_parameters.hpp
-)
+foreach(file aero_data;output)
+  execute_process(
+    COMMAND ${PYTHON_EXECUTABLE} "-c" "${cmd}"
+    INPUT_FILE ${CMAKE_SOURCE_DIR}/gitmodules/partmc/src/${file}.F90
+    OUTPUT_FILE ${CMAKE_BINARY_DIR}/include/${file}_parameters.hpp
+  )
+endforeach()
 
 target_include_directories(partmclib PRIVATE 
   ${SUNDIALS_SOURCE_DIR}/include

MANIFEST.in

@@ -3,6 +3,7 @@ graft gitmodules/partmc/src
 include gitmodules/partmc/src/condense_solver.c
 
 include gitmodules/camp/COPYING
+include gitmodules/camp/CMakeLists.txt
 graft gitmodules/camp/src
 
 include gitmodules/json-fortran/LICENSE

PyPartMC/__init__.py

@@ -43,4 +43,8 @@ def __build_extension_env():
 with __build_extension_env():
     import _PyPartMC
     from _PyPartMC import *
-    from _PyPartMC import __all__, __version__  # pylint: disable=no-name-in-module
+    from _PyPartMC import (  # pylint: disable=no-name-in-module
+        __all__,
+        __version__,
+        __versions_of_build_time_dependencies__,
+    )

README.md

@@ -278,6 +278,13 @@ flowchart TD
 - Q: Why some of the constructors expect data to be passed as **lists of single-entry dictionaries** instead of multi-element dictionaries?    
   A: This is intentional and related with PartMC relying on the order of elements within spec-file input; while Python dictionaries preserve ordering (insertion order), JSON format does not, and we intend to make these data structures safe to be [de]serialized using JSON.   
 
+- Q: How to check the version of PartMC that PyPartMC was compiled against?    
+  A: Version numbers of compile-time dependencies of PyPartMC, including PartMC, can be accessed as follows:
+```Python
+import PyPartMC
+PyPartMC.__versions_of_build_time_dependencies__['PartMC']
+```
+
 ## Troubleshooting 
 
 #### Common installation issues 

src/pypartmc.cpp

@@ -8,6 +8,8 @@
 #include "nlohmann/json.hpp"
 #include "pybind11_json/pybind11_json.hpp"
 #include "pybind11/complex.h"
+#include "sundials/sundials_config.h"
+#include "camp/version.h"
 
 #include "util.hpp"
 #include "rand.hpp"
@@ -25,6 +27,7 @@
 #include "camp_core.hpp"
 #include "photolysis.hpp"
 #include "output.hpp"
+#include "output_parameters.hpp"
 
 #define STRINGIFY(x) #x
 #define MACRO_STRINGIFY(x) STRINGIFY(x)
@@ -490,6 +493,16 @@ PYBIND11_MODULE(_PyPartMC, m) {
 
     m.attr("__version__") = MACRO_STRINGIFY(VERSION_INFO);
 
+    auto vobtd = py::dict();
+    vobtd["pybind11"] = MACRO_STRINGIFY(PYBIND11_VERSION_MAJOR) "." MACRO_STRINGIFY(PYBIND11_VERSION_MINOR) "." MACRO_STRINGIFY(PYBIND11_VERSION_PATCH);
+    vobtd["PartMC"] = PARTMC_VERSION;
+    vobtd["SUNDIALS"] = SUNDIALS_VERSION;
+    vobtd["CAMP"] = CAMP_VERSION;
+    // TODO #164
+    // - expose git hashes?
+    // - more submodules (netCDF, ...)
+    m.attr("__versions_of_build_time_dependencies__") = vobtd;
+
     m.attr("__all__") = py::make_tuple(
         "__version__",
         "AeroData",

tests/test_version.py

@@ -4,8 +4,29 @@
 # Authors: https://github.com/open-atmos/PyPartMC/graphs/contributors                              #
 ####################################################################################################
 
+import pytest
+
 import PyPartMC as ppmc
 
 
 def test_version():
-    print(ppmc.__version__)
+    assert 3 < len(ppmc.__version__) < 20
+
+
+@pytest.mark.parametrize(
+    "pkg",
+    (
+        "PartMC",
+        "pybind11",
+        "CAMP",
+        "SUNDIALS",
+    ),
+)
+def test_versions_of_build_time_dependencies(pkg):
+    sut = ppmc.__versions_of_build_time_dependencies__
+    assert 3 < len(sut[pkg]) < 20
+    assert '"' not in sut[pkg]
+
+
+def test_versions_of_build_time_dependencies_printable():
+    print(ppmc.__versions_of_build_time_dependencies__)