Restructure repository and use travis for releases (#1)

* Add .clang-format * Restructured the repository - more common folder structure - less effort compiling the tools by using SUBDIRS in qmake * Added .travis.yml * Update README.md * Fix bug in argument -t * Fix typo in readFile * Added CHANGELOG
cmeessen · Jun 16, 2020 · 3c6d1fc · 3c6d1fc
1 parent 09365bf
commit 3c6d1fc
Show file tree

Hide file tree

Showing 38 changed files with 819 additions and 642 deletions.
diff --git a/.clang-format b/.clang-format
@@ -0,0 +1,108 @@
+---
+Language:        Cpp
+# BasedOnStyle:  LLVM
+AccessModifierOffset: -2
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Right
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: false
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:   
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     80
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:   
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeCategories: 
+  - Regex:           '^"(llvm|llvm-c|clang|clang-c)/'
+    Priority:        2
+  - Regex:           '^(<|"(gtest|gmock|isl|json)/)'
+    Priority:        3
+  - Regex:           '.*'
+    Priority:        1
+IncludeIsMainRegex: '(Test)?$'
+IndentCaseLabels: false
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: true
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 19
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 60
+PointerAlignment: Right
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+Standard:        Cpp11
+TabWidth:        8
+UseTab:          Never
+...
+
diff --git a/.gitignore b/.gitignore
@@ -1,17 +1,14 @@
 bin/*
-V2RhoT/*.o
-V2RhoT/Makefile
-V2RhoT/V2RhoT
-V2RhoT/test.out
-V2RhoT/Makefile
-V2T/*.o
-V2T/Makefile
-V2T/V2T
-V2T/docs/*synctex.gz
-V2T/docs/*.log
-V2T/docs/*.aux
-V2T/docs/*.pdf
-V2T/Makefile
+/V2T
+/V2RhoT
+*.a
+*.o
+Makefile
+src/*/Makefile
+docs/*synctex.gz
+docs/*.log
+docs/*.aux
+docs/*.pdf
 .DS_Store
 .qmake.stash
 *.app

diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,22 @@
+language: cpp
+env:
+- QT_BASE=4
+- QT_BASE=5
+install:
+- sudo apt-get update -qq
+- sudo apt-get install -qq qt${QT_BASE}-default qt${QT_BASE}-qmake
+script:
+- qmake
+- make
+after_success:
+- tar -zcvf bin/bin-VeloDT-prerelease-ubuntu-qt${QT_BASE}-x86_64.tar.gz bin/V2RhoT
+  bin/V2T
+deploy:
+  provider: releases
+  api_key:
+    secure: ORqoxcPCHo19J3npN9/lFvwYMOuz7qifGg8G75OKIj3p3LlFdidmAHvWD1hd0Q3+zPXzNxG/CiAuwALjWFQdLIcB0vsKeeOlUII8/eGhDkaPjyW/VOdQT5XxqSevvtRdTIqJO2WAxO80TdZ6YZoz7Q9lkxSnGkpBH569pIIC2OkgcC62HGXT3jGlJ8I82fVl32uKTh2954kRRT5eXv24rYuGhp+jarc5n2io02HLOHLdz0qg3OcemFYJfbGJ7uPjQUh3lFJd6VfLX1cdkRYBFedsWST3y7i2+SnVUpIY+mr/bEGgf2xrE8OLXw4ABA8PhFloqkiHiOrkZ6Xc4Az+cmhZjOLAT04yL1HBpXrpUb8bpJVIfH5eda8ORwey/RST8JF/eqFM7pu+AXJpG9Fs6lEm/GczuTxMOcF3cTyxM3/Q96VZq3ZEVe8REuLqqyyy5J7IMifWZPH3hkWHjTYM2NsWroG45duFW+w3ts9QrLPOOwoXYgPMQ9CJJoo5lOrlfM4rOBujbXk+tn6QoyRFhne2mxIrHE4pcyfIwDz5bsi7ZxpfFa7sWaAro/DY+OGCuneNI1DtFJHGG0QzoCNVZXBTUUgeqQQf3Sp3XOF/O++yJ804+QS+fIMaAGB/fAo6l4d13zCpWqqQBjf3a5CcBve0aovSQHntid7xfW5tBNs=
+  file: bin/bin-VeloDT-prerelease-ubuntu-qt${QT_BASE}-x86_64.tar.gz
+  on:
+    tags: true
+    repo: cmeessen/VeloDT
+  skip_cleanup: 'true'
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [1.1.0] - 2020-06-16
+
+### Added
+
+- CHANGELOG
+- Build binaries for Ubuntu using QT4 and QT5 and release them when a tag is
+  added
+
+### Changed
+
+- Repository structure changed, using include and src folders
+
+### Fixed
+
+- Fixed an bug when using argument `-t`
+- Fixed an typo in `readFile()` that made it impossible to use topography or
+  crustal thickness maps
diff --git a/Example/Makefile b/Example/Makefile
@@ -1,5 +1,5 @@
-V2RhoT = ../V2RhoT/V2RhoT
-V2T = ../V2T/V2T
+V2RhoT = ../bin/V2RhoT
+V2T = ../bin/V2T
 # Plot properties
 FIGURE = results.ps
 ROI_T = 450/1450/-200/-50
@@ -9,7 +9,7 @@ MAPWIDTH = 6
 
 # Targets
 
-clean: plot
+clean:
 	rm Vs.dat Vp.dat V2RhoT_Vs.dat V2RhoT_Vp.dat V2T_Vs.dat gmt.*
 
 plot: convert

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # VeloDT
-[![DOI](https://zenodo.org/badge/121383426.svg)](https://zenodo.org/badge/latestdoi/121383426)
 
+[![DOI](https://zenodo.org/badge/121383426.svg)](https://zenodo.org/badge/latestdoi/121383426)
+[![Build Status](https://travis-ci.org/cmeessen/VeloDT.svg?branch=restructure-repo)](https://travis-ci.org/cmeessen/VeloDT)
 
 *VeloDT* contains two C++ implementations of *Vp*- and/or *Vs*-conversions to temperature and/or density valid in the upper mantle.
 
@@ -13,14 +14,17 @@ different approaches.
 ## Getting started
 
 Either clone the github repository with
-```
+
+```bash
 git clone https://github.com/cmeessen/VeloDT.git
 ```
-or download the [latest release](https://github.com/cmeessen/VeloDT/releases/latest) as source code or binary and extract it somewhere. If you downloaded the source code, you will have to compile the code. Therefore, navigate into the folders `V2RhoT` or `V2T` which both contain a README.md with instructions on compilation and usage
 
-- [**V2RhoT**](./V2RhoT/) closely follows [Goes et al. (2000)](https://doi.org/10.1029/1999JB900300) to convert vp or
+or download the [latest release](https://github.com/cmeessen/VeloDT/releases/latest) as source code or binary and extract it somewhere. If you downloaded the source code, you will have to compile the code (see below).
+
+- [**V2RhoT**](./V2RhoT.md) closely follows [Goes et al. (2000)](https://doi.org/10.1029/1999JB900300) to convert vp or
 vs to temperature and density assuming a mineral assemblage
-- [**V2T**](./V2T/) implements the method by [Priestley and McKenzie
+
+- [**V2T**](./V2T.md) implements the method by [Priestley and McKenzie
 (2006)](https://doi.org/10.1016/j.epsl.2006.01.008) and converts *Vs* to temperature
 
 Please refer to the original publications for validity and pitfalls of the methods.
@@ -41,13 +45,15 @@ Requirements for plotting the example:
 
 ### Compiling
 
-Both tools are compiled in the same manner. Open the directory `V2RhoT` or `V2T` in a terminal and execute in the following order
+Navigate to the base folder `./VeloDT` and execute
 
-```
+```bash
 qmake
 make
 ```
 
+This will build the `V2RhoT` and `V2T` executables and put them in the `./VeloDT` folder.
+
 ## License
 
 VeloDT is published under the terms of [**GNU General Public License v3.0**](./LICENSE).

diff --git a/V2RhoT/README.md → V2RhoT.md b/V2RhoT/README.md → V2RhoT.md
diff --git a/V2T/README.md → V2T.md b/V2T/README.md → V2T.md
diff --git a/VeloDT.pro b/VeloDT.pro
@@ -0,0 +1,6 @@
+TEMPLATE = subdirs
+CONFIG -= app_bundle
+CONFIG += ordered
+SUBDIRS += src/common src/V2RhoT src/V2T
+V2RhoT.depends = common
+V2T.depends = common
diff --git a/common/PointClasses.h b/common/PointClasses.h
diff --git a/V2T/docs/constants.png → docs/constants.png b/V2T/docs/constants.png → docs/constants.png
diff --git a/V2T/docs/eqn1.png → docs/eqn1.png b/V2T/docs/eqn1.png → docs/eqn1.png
diff --git a/V2T/docs/eqn2.png → docs/eqn2.png b/V2T/docs/eqn2.png → docs/eqn2.png
diff --git a/V2T/docs/eqn3.png → docs/eqn3.png b/V2T/docs/eqn3.png → docs/eqn3.png
diff --git a/V2T/docs/eqn4.png → docs/eqn4.png b/V2T/docs/eqn4.png → docs/eqn4.png
diff --git a/V2T/docs/eqn5.png → docs/eqn5.png b/V2T/docs/eqn5.png → docs/eqn5.png
diff --git a/V2T/docs/eqn6.png → docs/eqn6.png b/V2T/docs/eqn6.png → docs/eqn6.png
diff --git a/V2T/docs/eqn7.png → docs/eqn7.png b/V2T/docs/eqn7.png → docs/eqn7.png
diff --git a/V2T/docs/eqn8.png → docs/eqn8.png b/V2T/docs/eqn8.png → docs/eqn8.png
diff --git a/V2T/docs/eqn9.png → docs/eqn9.png b/V2T/docs/eqn9.png → docs/eqn9.png
diff --git a/V2T/docs/eqns.tex → docs/eqns.tex b/V2T/docs/eqns.tex → docs/eqns.tex
diff --git a/V2RhoT/MineraldRhodT.h → include/V2RhoT/MineraldRhodT.h b/V2RhoT/MineraldRhodT.h → include/V2RhoT/MineraldRhodT.h
@@ -32,7 +32,6 @@ This class hosts the mineral property dRho/dT
 It must be calculated numerically to avoid errors far away from the reference
 temperature. The values will be stored in arrays.
 **/
-private:
   // Variables
   double Tmin, Tmax;
   QList <QList <double> > vals;
@@ -43,10 +42,10 @@ temperature. The values will be stored in arrays.
                  double Gnt);
   void fill();             // Calculate dRho/dT tables
 
-public:
+ public:
   MineraldRhodT();
   bool set_AlphaMode(int mode);
-  double dRhodT(double T, int mineral); // Returns dRhodT at T
+  double dRhodT(double T, int mineral);  // Returns dRhodT at T
   void exportTable();
 };