Merge pull request #578 from TeamCOMPAS/latex_CI

Latex CI

Author: jeffriley

…ithub/workflows/compilation-tests-ci.yml .github/workflows/compas-compile-ci.yml.github/workflows/compilation-tests-ci.yml renamed to .github/workflows/compas-compile-ci.yml .github/workflows/compilation-tests-ci.yml renamed to .github/workflows/compas-compile-ci.yml

@@ -1,13 +1,10 @@
-name: CI Test Compilation of various COMPAS components
+name: COMPAS compile test
 
-on:
-  pull_request:
-      branches: [ dev ]
-  #push: # testing
+on: [pull_request]
 
 jobs:
   compas:
-    name: Build Docker image and push to DockerHub
+    name: Build COMPAS
     runs-on: ubuntu-18.04
     steps:
       - uses: actions/checkout@v2
@@ -17,5 +14,3 @@ jobs:
 
       - name: Build Compas
         run: cd src && make -j $(nproc) -f Makefile
-
-  # TODO: add latex and postprocessing python scripts

.github/workflows/latex-compile-ci.yml

@@ -0,0 +1,68 @@
+name: LaTeX compile test
+
+# Test Latex compiles on pull_requests
+# Public documentation on push to dev
+
+on:
+  pull_request:
+  push: 
+      branches: [dev] 
+
+jobs:
+  latex:
+    name: Build LaTeX documentation
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies 
+        run: sudo apt install texlive-base
+        
+      # Need to do pdflatex, bibtex, pdflatex, pdflatex
+      - name: pdflatex main
+        uses: dante-ev/latex-action@latest
+        with:
+          working_directory: docs/COMPAS_LaTeX
+          root_file: main.tex
+          compiler: pdflatex
+          args: -interaction=nonstopmode -shell-escape
+
+      - name: bibtex main
+        uses: dante-ev/latex-action@latest
+        with:
+          working_directory: docs/COMPAS_LaTeX
+          root_file: main.aux
+          compiler: bibtex 
+          args: 
+
+      - name: pdflatex main
+        uses: dante-ev/latex-action@latest
+        with:
+          working_directory: docs/COMPAS_LaTeX
+          root_file: main.tex
+          compiler: pdflatex
+          args: -interaction=nonstopmode -shell-escape
+          
+      - name: pdflatex main
+        uses: dante-ev/latex-action@latest
+        with:
+          working_directory: docs/COMPAS_LaTeX
+          root_file: main.tex
+          compiler: pdflatex
+          args: -interaction=nonstopmode -shell-escape
+
+
+      # If push to dev, publish the documentation
+      - name: publish documentation 
+        if: github.event_name == 'push' 
+        run: |
+          git checkout --orphan Documentation
+          PDF_FILE=COMPAS_Documentation.pdf
+          mv docs/COMPAS_LaTeX/main.pdf $PDF_FILE
+          git rm -rf .
+          git add -f $PDF_FILE
+          git config user.name "Team COMPAS"
+          git config user.email "<>"
+          git commit -m "Documentation update"
+          git push -f --set-upstream origin Documentation

.gitignore

@@ -21,13 +21,13 @@ Thumbs.db
 __pycache__/
 COMPAS_Output*/
 output*/
-.github/
 COMPAS
 *.log
 *.aux
 *.toc
 *.bbl
 *.blg
+*.pdf
 *.synctex
 *.synctex(busy)
 *.synctex.gz

README.md

@@ -4,14 +4,16 @@
 
 # Compact Object Mergers: Population Astrophysics & Statistics
 
+[![Documentation](https://img.shields.io/badge/Documentation-latest-orange.svg?style=flat)](https://github.com/TeamCOMPAS/COMPAS/blob/Documentation/COMPAS_Documentation.pdf)
+
 [//]: ## (Outline features)
 COMPAS is a publicly available rapid binary population synthesis code (https://compas.science/) that is designed so that evolution prescriptions and model parameters are easily 
 adjustable.  COMPAS draws properties for a binary star system from a set of initial distributions, and evolves it from zero-age main sequence to the end of its life as two compact 
 remnants.  It has been used for inference from observations of gravitational-wave mergers, Galactic neutron stars, X-ray binaries, and luminous red novae.
 
 ## Documentation
 [Getting started](./docs/getting_started.md)  
-[Specifications](./docs/COMPAS_Doc.pdf)  
+[Specifications](https://github.com/TeamCOMPAS/COMPAS/blob/Documentation/COMPAS_Documentation.pdf)  
 [Post-processing](./postProcessing/README.txt)  
 [Running COMPAS inside a Docker container](./docs/docker.md)