Merge pull request #91 from glwhart/master

Added automatic versioning functionality

Author: wsmorgan

HISTORY.md

@@ -1,5 +1,18 @@
 # Revision History for `enumlib`
 
+## 2.0.4 (GLWH)
+- At the request of `mkhorton` (Issue \#89), added the functionality for the enumeration code to print out a version number each time `gen_multilatice_derivatives` is called. The filename is `VERSON.enum`. The version number written to the file is generated by `git describe --tags --abbrev=4 --always`. The `Makefile` embeds the output of `git describe` into the source code at compile time.
+- This change requires the developers to 1) tag their releases, and 2) push the tags (`git push` does not do this by default). Suggest that each time one of us commits that we do the following: (see `https://git-scm.com/book/en/v2/Git-Basics-Tagging`)
+
+`git tag vX.Y.Z` where the version number matches the rev. number in `HISTORY.md`  
+`git push origin vX.Y.Z`
+
+
+## 2.0.3 (GLWH)
+- Made changes in `aux_src/compare_two_enum_files.f90` so that two output files could be compared, including considering the automorphism induced by changes to the Smith Normal Form routine (that made in more robust against overflow when used in the "on the fly" generalized regular kpoint grid generation code). This allowed us to update all the unit tests after the changes to the SNF routine in `symlib` which impacted the output in many cases. When the left transform matrix associated with the transformation of an HNF matrix to SNF matrix changes (it is not unique), that change affects the enumeration output. The enumeration is *equivalent*, but not always identical to, the previous (pre-SNF change) enumeration. Figuring out how to compute and apply the automorphism, how to take into account permutations of labelings in the old and new files, and how to take into account complementary cases (when labels are exchanged) took months.
+- Many other small changes (improved comments throughout, removal of debugging print statements, etc.).
+- Now that these changes have been made, the rest of the updates needed to complete the "inactive site" work of version 2.0.0 can be made.
+
 ## 2.0.2 (JJ)
 - Fixed functions in `enumlib/wrap` to reflect changes to `get_dvector_permutations`.
 
@@ -99,11 +112,11 @@ changes, so committing/pushing again.
 - Fixed the maxLabLength in makePerovStr.f90 to be 100. Also fixed the
   call to reduce_to_shortest_basis as described in issue #38.
 
-## Revision 1.0.6
+## Revision 1.0.6 (WSM)
 
 - The maximum allowed binomial, max_binomial in
   src/derivative_structure_generator.f90, had been set to
-  2.63E14. This number was to large and allowed the code to enter the
+  2.63E14. This number was too large and allowed the code to enter the
   generate_permutation_labelings algorithm when it should have been
   entering the recursively_stabilized_enum algorithm. The max_binomial
   is now 1E10 to force the correct behavior.
@@ -120,25 +133,25 @@ changes, so committing/pushing again.
 - Fixed bug in makeStr.py, the lattice vectors in struct_enum.out were
   being treated as column and not row vectors.
 
-## Revision 1.0.4
+## Revision 1.0.4 (WSM)
 
-- Removed depricated code from line 443 of tree_class.f90.
+- Removed deprecated code from line 443 of tree_class.f90.
 
 - Added more extensive comments to explain the loop structure of line
-  171 of labelin_related.f90.
+  171 of `labeling_related.f90`.
 
 - Removed the `if (d==0) then` statement from addArrowsToEnumeration
   of tree_class.f90 since the code now handles all depths
   appropriately.
 
-- Fixed merge conflits with master branch.
+- Fixed merge conflicts with master branch.
 
 ## Revision 1.0.3
 
 - Fixed a bug number of bugs in the addArrows subroutine of
-  tree_class.f90.
+  `tree_class.f90`.
 
-- Added nArrows as an input to tree_class and as an output to
+- Added `nArrows` as an input to tree_class and as an output to
   arrow_concs of arrow_related.
 
 - Fixed the generateArrowingFromIndex subroutine so that it returns
@@ -148,7 +161,7 @@ changes, so committing/pushing again.
 - Fixed the color_mapping of the arrowed labels for the site
   restricted cases in labeling_related.
 
-- Added makeStr.py to the repo to replace makeStr.x.
+- Added `makeStr.py` to the repo to replace makeStr.x.
 
 ## Revision 1.0.2
 
@@ -160,7 +173,7 @@ changes, so committing/pushing again.
   .and. .not. use_arrows)) stop "(d,g)-->(d',g') mapping failed in
   get_rotation_perm_lists"`.
 
-## Revision 1.0.1
+## Revision 1.0.1 (WSM)
 - Updated the polya submodule.
 - Fixed a bug in tree_class.f90 that was causing a segmentation fault
   in the arrow enumeration. The error was caused because using
@@ -170,8 +183,8 @@ changes, so committing/pushing again.
   this permutation should.
 
 - Fixed the final color mapping in the arrow enumeration. The location
-  of the old coloring in the old coloring was incorect because the
-  computation used the sizee of the color map as a metric rather than
+  of the old coloring in the old coloring was incorrect because the
+  computation used the size of the color map as a metric rather than
   the difference in the number of colors vs the number of arrows. As a
   result self%color_map(coloring(site_i)-size(self%color_map,1),2) -1
   was replaced with

src/Makefile

@@ -81,6 +81,7 @@ lib: pre_comp libenum.a
 
 pre_comp:
 	+$(MAKE) -C ../symlib/src
+	sed -i.bak "s/\(write(23,'(A)')\)\(.*\)/\1 \"`git describe --tags --dirty --abbrev=4`\"/" derivative_structure_generator.f90
 
 libenum.a: ${OBJS}
 	ar ru $@ $?

src/derivative_structure_generator.f90

@@ -1217,6 +1217,7 @@ SUBROUTINE gen_multilattice_derivatives(title, parLV, nDFull, dFull, k, nMin, nM
     integer             :: nD
     !Had to change character to 80 from 10 to match the definition in io_utils.read_input
     character(80), intent(in) :: title
+    character(len=255) :: version
     real(dp), intent(in) :: parLV(3,3), eps
     real(dp), allocatable :: dFull(:,:), d(:,:)
     character(1), intent(in) :: pLatTyp
@@ -1268,6 +1269,9 @@ SUBROUTINE gen_multilattice_derivatives(title, parLV, nDFull, dFull, k, nMin, nM
     max_binomial = 1E10
 
     ! Beginning of main routine for enumeration
+    open(23,file="VERSION.enum")
+    write(23,'(A)') "v2.0.3-1-g2eca-dirty"
+    close(23)
 
     ![TODO] Get rid of all the junk that crept in (writing files, making inactives table, etc. These should all be in routines so that this main routine is still readable)