added git hash to binaries

Author: dtamayo

README.rst

@@ -1,4 +1,4 @@
-.. image:: http://img.shields.io/badge/REBOUNDx-v2.15.0-green.svg?style=flat
+.. image:: http://img.shields.io/badge/REBOUNDx-v2.15.1-green.svg?style=flat
     :target: http://reboundx.readthedocs.org
 .. image:: https://badge.fury.io/py/reboundx.svg
     :target: https://badge.fury.io/py/reboundx

doc/conf.py

@@ -205,7 +205,7 @@ def cleanline(line):
 # The short X.Y version.
 version = '2.15'
 # The full version, including alpha/beta/rc tags.
-release = '2.15.0'
+release = '2.15.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

doc/index.rst

@@ -3,7 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to REBOUNDx (2.15.0)
+Welcome to REBOUNDx (2.15.1)
 ============================
 
 .. image:: images/hlTau.png

reboundx/__init__.py

@@ -19,6 +19,9 @@
 __build__ = c_char_p.in_dll(clibreboundx, "rebx_build_str").value.decode('ascii')
 # Check for version
 
+# Githash
+__githash__ = c_char_p.in_dll(clibrebound, "reb_githash_str").value.decode('ascii')
+
 try:
     moduleversion = pkg_resources.require("reboundx")[0].version
     libreboundxversion = __version__
@@ -40,4 +43,4 @@ def params(self):
 from .extras import Extras, Param, Effect
 from .tools import coordinates, install_test
 from .params import Params
-__all__ = ["Extras", "Param", "Effect", "Params", "coordinates", "install_test"]
+__all__ = ["__version__", "__build__", "__githash__", "Extras", "Param", "Effect", "Params", "coordinates", "install_test"]

setup.py

@@ -15,6 +15,14 @@
 if suffix is None:
     suffix = ".so"
 
+# Try to get git hash
+try:
+    import subprocess
+    ghash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode("ascii")
+    ghash_arg = "-DREBXGITHASH="+ghash
+except:
+    ghash_arg = "-DREBXGITHASH=de6647e2b083fc91472d636355512ada02b9f3f6" #GITHASHAUTOUPDATE
+
 class build_ext(_build_ext):
     def finalize_options(self):
         _build_ext.finalize_options(self)
@@ -53,7 +61,7 @@ def finalize_options(self):
                     runtime_library_dirs = ["."],
                     libraries=['rebound'+suffix[:-3]], #take off .so from the suffix
                     define_macros=[ ('LIBREBOUNDX', None) ],
-                    extra_compile_args=['-fstrict-aliasing', '-O3','-std=c99','-march=native', '-fPIC', '-Wpointer-arith'],
+                    extra_compile_args=['-fstrict-aliasing', '-O3','-std=c99','-march=native', ghash_arg, '-fPIC', '-Wpointer-arith'],
                     extra_link_args=extra_link_args,
                     )
 
@@ -62,7 +70,7 @@ def finalize_options(self):
     long_description = f.read()
 
 setup(name='reboundx',
-    version='2.15.0',
+    version='2.15.1',
     description='A library for including additional forces in REBOUND',
     long_description=long_description,
     url='http://github.com/dtamayo/reboundx',

src/Makefile

@@ -17,6 +17,11 @@ endif
 include $(REB_DIR)/src/Makefile.defs
 OPT+= -fPIC -DLIBREBOUNDX
 
+ifndef REBXGITHASH
+	REBXGITHASH = $(shell git rev-parse HEAD || echo '0000000000gitnotfound0000000000000000000')
+	PREDEF+= -DREBXGITHASH=$(REBXGITHASH)
+endif
+
 SOURCES=central_force.c core.c gr.c gr_full.c gr_potential.c input.c modify_mass.c modify_orbits_direct.c modify_orbits_forces.c output.c radiation_forces.c rebxtools.c tides_precession.c track_min_distance.c 
 OBJECTS=$(SOURCES:.c=.o)
 HEADERS=rebxtools.h reboundx.h

src/core.c

@@ -32,9 +32,12 @@
 #include <limits.h>
 #include "core.h"
 #include "rebound.h"
+#define STRINGIFY(s) str(s)
+#define str(s) #s
 
 const char* rebx_build_str = __DATE__ " " __TIME__; // Date and time build string. 
-const char* rebx_version_str = "2.15.0";         // **VERSIONLINE** This line gets updated automatically. Do not edit manually.
+const char* rebx_version_str = "2.15.1";         // **VERSIONLINE** This line gets updated automatically. Do not edit manually.
+const char* rebx_githash_str = STRINGIFY(GITHASH);             // This line gets updated automatically. Do not edit manually.
 
 /*****************************
  Initialization routines.

src/input.c

@@ -196,13 +196,14 @@ void rebx_create_extras_from_binary_with_messages(struct rebx_extras* rebx, cons
     long objects = 0;
     // Input header.
     const char str[] = "REBOUNDx Binary File. Version: ";
+    const char zero = '\0';
     char readbuf[65], curvbuf[65];
     sprintf(curvbuf,"%s%s",str,rebx_version_str);
-    for(size_t j=strlen(curvbuf);j<63;j++){
-        curvbuf[j] = ' ';
-    }
-    curvbuf[63] = '\0';
+    memcpy(curvbuf+strlen(curvbuf)+1,rebx_githash_str,sizeof(char)*(62-strlen(curvbuf)));
+    curvbuf[63] = zero;
+    
     objects += fread(readbuf,sizeof(*str),64,inf);
+    // Note: following compares version, but ignores githash.
     if(strcmp(readbuf,curvbuf)!=0){
         *warnings |= REBX_INPUT_BINARY_WARNING_VERSION;
     }

src/output.c

@@ -131,15 +131,13 @@ void rebx_output_binary(struct rebx_extras* rebx, char* filename){
 
     // Output header.
     const char str[] = "REBOUNDx Binary File. Version: ";
+    char zero = '\0';
     size_t lenheader = strlen(str)+strlen(rebx_version_str);
     fwrite(str,sizeof(char),strlen(str),of);
     fwrite(rebx_version_str,sizeof(char), strlen(rebx_version_str),of);
-    while (lenheader<64){ //padding
-        char space = ' ';
-        if (lenheader==63) space = '\0';
-        fwrite(&space,sizeof(char),1,of);
-        lenheader += 1;
-    }
+    fwrite(&zero,sizeof(char),1,of);
+    fwrite(rebx_githash_str,sizeof(char),62-lenheader,of);
+    fwrite(&zero,sizeof(char),1,of);
 
     int neffects=0;
     struct rebx_effect* current = rebx->effects;
@@ -164,4 +162,4 @@ void rebx_output_binary(struct rebx_extras* rebx, char* filename){
     // Write end marker for binary
     REBX_WRITE_FIELD(END,           NULL,                   0,                              0);
     fclose(of);
-}
+}

src/reboundx.h

@@ -34,9 +34,13 @@
 #include <limits.h>
 #include "rebound.h"
 #include "rebxtools.h"
+#ifndef REBXGITHASH
+#define REBXGITHASH notavailable0000000000000000000000000001 
+#endif // REBXGITHASH
 
 extern const char* rebx_build_str;      ///< Date and time build string.
 extern const char* rebx_version_str;    ///<Version string.
+extern const char* rebx_githash_str;    ///< Current git hash.
 
 /******************************************
   REBOUNDx Enums 

update_version.py

@@ -1,6 +1,8 @@
 #!/usr/bin/python
 # This script automatically creates a list of examples by reading the header in all problem.c files.
 import glob
+import subprocess
+ghash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode("ascii").strip()
 
 with open("version.txt") as f:
     reboundxversion = f.readlines()[0].strip()
@@ -43,6 +45,8 @@
     for i,l in enumerate(setuplines):
         if "version='" in l:
             setuplines[i] = "    version='"+reboundxversion+"',\n"
+        if "GITHASHAUTOUPDATE" in l:
+            setuplines[i] = "    ghash_arg = \"-DREBXGITHASH="+ghash+"\" #GITHASHAUTOUPDATE\n"
 
     with open("setup.py", "w") as f:
         f.writelines(setuplines)

version.txt

@@ -1 +1 @@
-2.15.0
+2.15.1