Merge branch 'master' into dtracers-patch-1

.github/workflows/benchmarking-master.yml

@@ -0,0 +1,65 @@
+# Uploads benchmarking data on push to master.
+
+name: Benchmarking (Master)
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        benchtest: [short_sample, short_dropshot, full_rumble, oce_rlcs, intensive_oce_rlcs]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.7'
+        architecture: 'x64'
+
+    - name: Install/Update pip and wheel.
+      run:
+        python -m pip install --upgrade pip &&
+        pip install wheel
+
+    - name: Set-up and install protobuf.
+      run: chmod 777 ./_travis/install-protoc.sh && ./_travis/install-protoc.sh 2.6.1
+
+    - name: Install dependencies.
+      run: pip install -r requirements.txt && pip install -r requirements-test.txt
+
+    - name: Initialise.
+      run: python init.py
+
+    - name: Prepare benchmark.
+      run: |
+        pip install -r requirements.txt && pip install -r requirements-test.txt
+        cd carball/tests/benchmarking
+        echo === BENCHMARK DIRECTORY ===
+        ls -lh
+        echo ===========================
+
+    - name: Run benchmark.
+      run: |
+        cd carball/tests/benchmarking
+        pytest benchmarking.py --benchmark-json carball_benchmarking.json -k 'test_${{matrix.benchtest}}'
+
+    # REQUIRES gh-pages BRANCH IN THE MAIN REPO (for the graphs).
+    - name: Process and store benchmark ${{matrix.benchtest}}.
+      if: contains(github.ref, 'master')
+      uses: rhysd/github-action-benchmark@v1
+      with:
+        name: Carball Benchmarks ${{matrix.benchtest}}
+        tool: 'pytest'
+        output-file-path: carball/tests/benchmarking/carball_benchmarking.json
+        benchmark-data-dir-path: dev/bench/${{matrix.benchtest}}/
+        # Use personal access token instead of GITHUB_TOKEN due to
+        # https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869/highlight/false
+        github-token: ${{ secrets.GH_WIKI_EDIT_TOKEN }}
+        auto-push: true
+        alert-threshold: '125%' # If performance is 1.25x worse, there will be an alert
+        comment-always: false
+        comment-on-alert: false # I think benchmarking.yml takes care of this.

.github/workflows/benchmarking.yml

@@ -0,0 +1,61 @@
+# Comment performance benchmarking on every push.
+
+name: Benchmarking
+
+on: push
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        benchtest: [short_sample, short_dropshot, full_rumble, oce_rlcs, intensive_oce_rlcs]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.7'
+        architecture: 'x64'
+
+    - name: Install/Update pip and wheel.
+      run:
+        python -m pip install --upgrade pip &&
+        pip install wheel
+
+    - name: Set-up and install protobuf.
+      run: chmod 777 ./_travis/install-protoc.sh && ./_travis/install-protoc.sh 2.6.1
+
+    - name: Install dependencies.
+      run: pip install -r requirements.txt && pip install -r requirements-test.txt
+
+    - name: Initialise.
+      run: python init.py
+
+    - name: Prepare benchmark.
+      run: |
+        pip install -r requirements.txt && pip install -r requirements-test.txt
+        cd carball/tests/benchmarking
+        echo === BENCHMARK DIRECTORY ===
+        ls -lh
+        echo ===========================
+
+    - name: Run benchmark.
+      run: |
+        cd carball/tests/benchmarking
+        pytest benchmarking.py --benchmark-json carball_benchmarking.json -k 'test_${{matrix.benchtest}}'
+
+    - name: Process and store benchmark ${{matrix.benchtest}}.
+      uses: rhysd/github-action-benchmark@v1
+      with:
+        name: Carball Benchmarks ${{matrix.benchtest}}
+        tool: 'pytest'
+        output-file-path: carball/tests/benchmarking/carball_benchmarking.json
+        benchmark-data-dir-path: dev/bench/${{matrix.benchtest}}/
+        # Use personal access token instead of GITHUB_TOKEN due to
+        # https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/td-p/26869/highlight/false
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        auto-push: false
+        alert-threshold: '125%' # If performance is 1.25x worse, there will be an alert
+        comment-always: true
+        fail-on-alert: true

.github/workflows/wiki.yml

@@ -0,0 +1,44 @@
+name: Update and upload DataFrame information.
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.7' # Version range or exact version of a Python version to use, using SemVer's version range syntax
+        architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
+
+    - name: Install/Update pip and wheel.
+      run:
+        python -m pip install --upgrade pip &&
+        pip install wheel
+
+    - name: Set-up and install protobuf.
+      run: chmod 777 ./_travis/install-protoc.sh && ./_travis/install-protoc.sh 2.6.1
+
+    - name: Install dependencies.
+      run: pip install -r requirements.txt
+
+    - name: Initialise.
+      run: python init.py
+
+    - name: Create document
+      run: python -m carball.tests.docs.data_frame_docs
+
+    - name: wiki-page-creator-action
+      uses: Decathlon/[email protected]
+      env:
+        GH_PAT: ${{ secrets.GH_WIKI_EDIT_TOKEN }}
+        ACTION_MAIL: [email protected]
+        ACTION_NAME: saltie
+        OWNER: SaltieRL
+        REPO_NAME: carball
+        MD_FOLDER: carball/tests/docs/
+        SKIP_MD: df_methods.md, df_summary.md

.gitignore

@@ -14,3 +14,4 @@ dist/
 *ipynb*
 
 !/carball/tests/replays/
+.vscode

.travis.yml

@@ -3,6 +3,7 @@ language: python
 python:
 - '3.6'
 - '3.7'
+- '3.8'
 
 addons:
   apt:

CARBALL_VERSION

@@ -1 +1 @@
-35
+36

README.md

@@ -88,6 +88,9 @@ with gzip.open(os.path.join('output.gzip'), 'wb') as fo:
 # return the proto object in python
 proto_object = analysis_manager.get_protobuf_data()
 
+# return the proto object as a json object
+json_oject = analysis_manager.get_json_data()
+
 # return the pandas data frame in python
 dataframe = analysis_manager.get_data_frame()
 ```

_travis/install-protoc.sh

@@ -13,8 +13,11 @@ unzip protobuf-${protoc_version}.zip
 cd protobuf-${protoc_version}
 echo "CONFIGURING PROTOBUF"
 ./configure
-echo "COMPILING PROTOBUF"
+echo "COMPILING and INSTALLING PROTOBUF and SHARED LIBRARIES (.libs)"
 make
+make check
+sudo make install
+sudo ldconfig
 echo "GETTING PROTOBUF VERSION"
 ./src/protoc --version
 echo "CLEANING UP"
@@ -25,3 +28,5 @@ pwd
 ls -lh
 echo "COPYING PROTOBUF TO NEW DIRECTORY"
 cp ./protobuf-${protoc_version}/src/protoc carball/generated/binaries
+cd carball/generated/binaries
+ls -lh