Merge pull request #23 from dstl/release/1.0.0

Release/1.0.0

.dockerignore

@@ -1,3 +1,3 @@
 venv/
 .pytest_cache
-*.egg-info
+*.egg-info

.flake8

@@ -1,7 +1,10 @@
 [flake8]
 max-line-length=200
 extend-ignore =
-    D107 # Missing docstring in __init__
-    D100 # Req for docstring at the top of each module
-    D104 # Req for docstring in public package
-    E203 # Whitespace before :
+    D107
+    D100
+    D104
+    E203
+    D401
+exclude =
+    docs/source/_autosummary

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behaviour:
+1. Import '...'
+2. Instantiate '....'
+3. Pass to '....'
+4. Run '....'
+5. See error
+
+**Expected behaviour**
+A clear and concise description of what you expected to happen.
+
+**Screenshots/Outputs**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. Ubuntu 22.04]
+ - Python: [e.g. 3.10.7]
+ - YT Version: [e.g. v1.0.0]
+ - Software: [e.g. cli, Jupyter, PyCharm, VSCode etc.]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[REQUEST]"
+labels: feature_request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build-sphinx.yml

@@ -0,0 +1,45 @@
+name: build-sphinx-to-github-pages
+
+env:
+  GITHUB_ACTOR: dstl
+  GITHUB_REPOSITORY: dstl/YAWNING-TITAN
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN}}
+
+on:
+  push:
+    branches: [main]
+
+
+jobs:
+
+  build_sphinx_job:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - name: Get prerequisites and clone repository
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -x
+          sudo apt-get update
+          sudo apt-get install -y git
+          sudo add-apt-repository ppa:deadsnakes/ppa -y
+          sudo apt install python3.10-dev -y
+          python -m pip install --upgrade pip
+          git clone "https://token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" .
+        shell: bash
+
+      - name: Install Yawning-Titan for docs autosummary
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          python -m pip install build
+          python -m pip install wheel
+          python -m pip install -e .[dev]
+      - name: Run build script for Sphinx pages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        run: |
+          bash $PWD/docs/build-sphinx-docs-to-github-pages.sh

.github/workflows/python-ci.yaml

@@ -2,18 +2,25 @@ name: Python package
 
 on:
   push:
-    branches: [main]
+    branches:
+      - main
+      - dev
+      - dev-gui
+      - 'releases/**'  # dev-gui to be removed once dev-gui branch is dropped
   pull_request:
-    branches: [main]
-
+    branches:
+      - main
+      - dev
+      - dev-gui
+      - 'releases/**'  # dev-gui to be removed once dev-gui branch is dropped
 jobs:
   build:
 
     runs-on: ubuntu-latest
-    timeout-minutes: 10
+    timeout-minutes: 15
     strategy:
       matrix:
-        python-version: ["3.8", "3.9"]
+        python-version: ["3.8", "3.9", "3.10"]
 
     steps:
       - uses: actions/checkout@v3
@@ -26,12 +33,19 @@ jobs:
           sudo apt update
           sudo add-apt-repository ppa:deadsnakes/ppa -y
           sudo apt install python${{ matrix.python-version}}-dev -y
-      - name: Install dependencies
+      - name: Install Build Dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install wheel
+          pip install build
+          pip install wheel
+      - name: Build Yawning-Titan
+        run: |
+          python setup.py sdist
+      - name: Install Yawning-Titan
+        run: |
+          YT=$(ls ./dist/yawningtitan-*.*.*.tar.gz)
           python -m pip install torch==1.11+cpu -f https://download.pytorch.org/whl/torch_stable.html
-          python -m pip install .[dev] --default-timeout 1000
+          python -m pip install $YT[dev] --default-timeout 1000
       - name: Lint with flake8
         run: |
           # stop the build if there are Python syntax errors or undefined names
@@ -40,4 +54,4 @@ jobs:
           flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
       - name: Test with pytest
         run: |
-          pytest
+          pytest tests

.gitignore

@@ -1,4 +1,5 @@
-*venv/
+venv/
+YTFrontEnd/
 .idea/
 *.egg-info
 dist/

.modelling/README.md

@@ -0,0 +1,5 @@
+# Modelling & Diagrams
+
+A place to store any files related to design and modelling. Currently using:
+- [UMLet](https://www.umlet.com) for UML (.uxf file extension)
+- [ArchiMate](https://www.archimatetool.com/) for modelling (.archimate file extension)