initial commit

.github/utils/emmocheck_config.yml

@@ -0,0 +1,14 @@
+# Configurations used when running emmocheck from the ci_tests workflow
+skip:
+  - test_namespace
+
+test_quantity_dimension:
+  exceptions:
+    - electrochemistry.ElectrochemicalQuantity
+    - electrochemistry.ElectrochemicalKineticQuantity
+    - electrochemistry.ElectrochemicalTransportQuantity
+    - electrochemistry.ElectrochemicalThermodynamicQuantity
+    - electrochemistry.ElectrochemicalConstant
+    - BattINFO.BatteryQuantity
+    # We ignore reaction rate constant since its dimensionality may vary
+    - electrochemistry.ReactionRateConstant

.github/workflows/ci_tests.yml

@@ -0,0 +1,31 @@
+name: CI - Tests
+
+on: [pull_request]
+
+jobs:
+  emmocheck:
+    name: EMMO Check
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.9"
+
+    - name: Install EMMOntoPy
+      run: |
+        python -m pip install --upgrade pip
+        pip install -U setuptools wheel
+        pip install -r requirements.txt
+
+    - name: Run EMMO Check - battery-model-lithium-ion
+      run: |
+        emmocheck --verbose --url-from-catalog \
+          --skip test_namespace \
+          --skip test_quantity_dimension \
+          --configfile=.github/utils/emmocheck_config.yml \
+          battery-model-lithium-ion.ttl

.github/workflows/doc.yml

@@ -0,0 +1,72 @@
+name: "Sphinx: Render docs"
+
+on: 
+  push:
+    branches:
+      - 'main'
+
+env:
+  GIT_USER_NAME: BattINFO Developers
+  GIT_USER_EMAIL: "[email protected]"
+
+jobs:
+
+  updatepages:
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v4 #Uses python install action from here: https://github.com/marketplace?type=actions
+      with:
+        python-version: '3.10'  # Replace with the desired Python version
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install Markdown==3.4.3 rdflib==6.3.2  # Add any other dependencies if needed
+        
+    - name: Render documentation from ttl
+      run: python docs/ttl_to_rst.py
+
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+        pre-build-command: "apt-get update -y; apt-get install -y pandoc"
+
+    - name: Create context file from ttl
+      run: python docs/ttl_to_context.py
+
+    - name: Check if HTML context directory exists
+      run: |
+        if [ ! -d "docs/_build/html/context/" ]; then
+          echo "Creating HTML context directory"
+          sudo mkdir -p docs/_build/html/context/
+        else
+          echo "HTML context directory already exists"
+        fi
+    
+    - name: Copy context file to HTML directory
+      run: sudo cp context/context.json docs/_build/html/context/
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: documentationHTML
+        path: docs/_build/html/
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html
+
+