Update INSTALL.rst to explicitly mention python 2.7 dependency

CHANGELOG

@@ -26,3 +26,7 @@
 - modify setup.py to compile lbfgsb.f directly
 - added chrg_scorpion_wrap.cpp to interface with chrg_scorpion.f
 - shortened test for reduce scorpion --cgopt
+
+25-26 July 2017 CHR
+- renamed 69 method names (.py, .pyx, .cpp, .h) to lowercase with underscores, except Print.
+- Complete list in NAMES_TXN

INSTALL.rst

@@ -11,7 +11,7 @@ Quick setup guide
 
 This is the very minimal set of instructions required to install Ptools
 in a Python virtual environment.
-It assumes all Ptools dependencies have been duly installed::
+It assumes python 2.7 and all Ptools dependencies have been duly installed::
 
     $ virtualenv ptools-env
     $ source ptools-env/bin/activate
@@ -29,6 +29,7 @@ Building and installing Ptools
 
 The Ptools library has few dependencies namely :
 
+- python 2.7.xx
 - a C++ compiler (e.g. the `GNU Compiler`_),
 - a developers version of the Python_ interpreter,
 - the Boost_ library, 
@@ -185,4 +186,4 @@ location as described in `f2c.h: No such file or directory`_.
 .. _GNU Compiler: http://gcc.gnu.org/
 .. _Python: http://www.python.org/
 .. _Git: http://git-scm.com/
-.. _pip: https://pypi.python.org/pypi/pip
+.. _pip: https://pypi.python.org/pypi/pip

Makefile

@@ -33,7 +33,7 @@ clean-build:
 	rm -fr dist/
 	rm -fr .eggs/
 	rm -f bindings/_ptools.cpp
-	rm -f bindings/_cgopt.c
+	rm -f bindings/_cgopt.cpp
 	rm -f $(MANIFEST_OUT)
 	rm -f headers/gitrev.h
 	find . -name '*.egg-info' -exec rm -fr {} +
@@ -84,6 +84,11 @@ build: clean
 install:
 	python setup.py install --record $(MANIFEST_OUT)
 
+undo:
+	git checkout -- "*.py" "*.pyx" "*.cpp" "*.h"
+
+rename:
+	python names.py rename NAMES_TXN
 
 uninstall:
 	cat $(MANIFEST_OUT) | xargs rm -f 

Tests/__init__.py

@@ -58,7 +58,7 @@
 
 # ---------------------------------------------------------------------------
 #
-# Reduce test files
+# reduce test files
 #
 # ---------------------------------------------------------------------------
 TEST_REDUCE_DATA_DIR = os.path.join(TEST_DATA_DIR, 'reduce')
@@ -95,7 +95,7 @@
 
 # ---------------------------------------------------------------------------
 #
-# Translate test files
+# translate test files
 #
 # ---------------------------------------------------------------------------
 

Tests/cpp/cxxtest/ErrorFormatter.h

@@ -252,15 +252,15 @@ namespace CxxTest
 
         void dumpBuffer( const void *buffer, unsigned size )
         {
-            unsigned dumpSize = size;
-            if ( maxDumpSize() && dumpSize > maxDumpSize() )
-                dumpSize = maxDumpSize();
+            unsigned dumpsize = size;
+            if ( maxDumpsize() && dumpsize > maxDumpsize() )
+                dumpsize = maxDumpsize();
 
             const unsigned char *p = (const unsigned char *)buffer;
             (*_o) << "   { ";
-            for ( unsigned i = 0; i < dumpSize; ++ i )
+            for ( unsigned i = 0; i < dumpsize; ++ i )
                 (*_o) << byteToHex( *p++ ) << " ";
-            if ( dumpSize < size )
+            if ( dumpsize < size )
                 (*_o) << "... ";
             (*_o) << "}" << endl;
         }

Tests/cpp/cxxtest/TestRunner.h

@@ -82,23 +82,23 @@ namespace CxxTest
 #ifdef _CXXTEST_HAVE_EH
             bool _abortTestOnFail;
 #endif // _CXXTEST_HAVE_EH
-            unsigned _maxDumpSize;
+            unsigned _maxDumpsize;
 
         public:
             StateGuard()
             {
 #ifdef _CXXTEST_HAVE_EH
                 _abortTestOnFail = abortTestOnFail();
 #endif // _CXXTEST_HAVE_EH
-                _maxDumpSize = maxDumpSize();
+                _maxDumpsize = maxDumpsize();
             }
 
             ~StateGuard()
             {
 #ifdef _CXXTEST_HAVE_EH
                 setAbortTestOnFail( _abortTestOnFail );
 #endif // _CXXTEST_HAVE_EH
-                setMaxDumpSize( _maxDumpSize );
+                setMaxDumpsize( _maxDumpsize );
             }
         };
 
@@ -110,7 +110,7 @@ namespace CxxTest
 #ifdef _CXXTEST_HAVE_EH
                 setAbortTestOnFail( CXXTEST_DEFAULT_ABORT );
 #endif // _CXXTEST_HAVE_EH
-                setMaxDumpSize( CXXTEST_MAX_DUMP_SIZE );
+                setMaxDumpsize( CXXTEST_MAX_DUMP_SIZE );
             }
         };
     };

Tests/cpp/cxxtest/TestSuite.cpp

@@ -38,16 +38,16 @@ namespace CxxTest
     //
     // Max dump size
     //
-    static unsigned currentMaxDumpSize = CXXTEST_MAX_DUMP_SIZE;
+    static unsigned currentMaxDumpsize = CXXTEST_MAX_DUMP_SIZE;
 
-    unsigned maxDumpSize()
+    unsigned maxDumpsize()
     {
-        return currentMaxDumpSize;
+        return currentMaxDumpsize;
     }
 
-    void setMaxDumpSize( unsigned value )
+    void setMaxDumpsize( unsigned value )
     {
-        currentMaxDumpSize = value;
+        currentMaxDumpsize = value;
     }
 
     //

Tests/cpp/cxxtest/TestSuite.h

@@ -33,8 +33,8 @@ namespace CxxTest
     bool abortTestOnFail();
     void setAbortTestOnFail( bool value = CXXTEST_DEFAULT_ABORT );
 
-    unsigned maxDumpSize();
-    void setMaxDumpSize( unsigned value = CXXTEST_MAX_DUMP_SIZE );
+    unsigned maxDumpsize();
+    void setMaxDumpsize( unsigned value = CXXTEST_MAX_DUMP_SIZE );
 
     void doTrace( const char *file, unsigned line, const char *message );
     void doWarn( const char *file, unsigned line, const char *message );

Tests/cpp/cxxtest/Win32Gui.h

@@ -161,7 +161,7 @@ namespace CxxTest
 
         void registerWindowClass()
         {
-            _windowClass.cbSize = sizeof(_windowClass);
+            _windowClass.cbsize = sizeof(_windowClass);
             _windowClass.style = CS_HREDRAW | CS_VREDRAW;
             _windowClass.lpfnWndProc = &(Win32Gui::windowProcedure);
             _windowClass.cbClsExtra = 0;
@@ -189,7 +189,7 @@ namespace CxxTest
 		return;
 
 	    typedef void (WINAPI *FUNC)( void );
-	    FUNC func = (FUNC)GetProcAddress( dll, "InitCommonControls" );
+	    FUNC func = (FUNC)GetProcaddress( dll, "InitCommonControls" );
 	    if ( !func )
                 return;
 

Tests/cpp/cxxtest/X11Gui.h

@@ -251,14 +251,14 @@ namespace CxxTest
 
         void redraw()
         {
-            getWindowSize();
+            getWindowsize();
             drawSolidBar();
             drawDividers();
             drawPercentage();
             flush();
         }
 
-        void getWindowSize()
+        void getWindowsize()
         {
             XWindowAttributes attributes;
             XGetWindowAttributes( _display, _window, &attributes );

Tests/cpp/cxxtestgen.py

@@ -304,7 +304,7 @@ def scanLineForTest(suite, lineNo, line):
 
 
 def addTest(suite, name, line):
-    '''Add a test function to the current suite'''
+    '''add a test function to the current suite'''
     test = {'name': name,
             'suite': suite,
             'class': 'TestDescription_%s_%s' % (suite['name'], name),
@@ -356,7 +356,7 @@ def cstr(str):
 
 
 def addSuiteCreateDestroy(suite, which, line):
-    '''Add createSuite()/destroySuite() to current suite'''
+    '''add createSuite()/destroySuite() to current suite'''
     if which in suite:
         abort('%s:%s: %sSuite() already declared' % (suite['file'], str(line), which))
     suite[which] = line
@@ -383,7 +383,7 @@ def verifySuite(suite):
 
 
 def rememberSuite(suite):
-    '''Add current suite to list'''
+    '''add current suite to list'''
     global suites
     suites.append(suite)
 
@@ -539,7 +539,7 @@ def isDynamic(suite):
 
 
 def writeInclude(output, file):
-    '''Add #include "file" statement'''
+    '''add #include "file" statement'''
     global lastIncluded
     if file == lastIncluded:
         return