Merge branch 'develop' into pre-commit-ci-update-config

.all-contributorsrc

@@ -28,6 +28,16 @@
         "review",
         "bug"
       ]
+    },
+    {
+      "login": "AlexNDRmac",
+      "name": "Oleksandr Andriiako",
+      "avatar_url": "https://avatars.githubusercontent.com/u/29776808?v=4",
+      "profile": "https://github.com/AlexNDRmac",
+      "contributions": [
+        "infra",
+        "test"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+name: CI
+
+on: [ push, pull_request, release ]
+
+jobs:
+  static-analysis:
+    if: github.event_name != 'release'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pre-commit/action@v3.0.0
+
+  testing:
+    needs: ['static-analysis']
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ 'ubuntu-latest', 'macos-latest', 'windows-latest' ]
+        python-version: [ '3.9', '3.10' ]
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install poetry
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install poetry
+
+      - name: Get Poetry Cache Dir
+        shell: bash
+        run: |
+          echo "POETRY_CACHE_DIR=$(poetry config cache-dir)" >> $GITHUB_ENV
+
+      - name: Cache Poetry Packages
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.POETRY_CACHE_DIR }}
+          key: ${{ runner.os }}-poetry-py${{ matrix.python-version }}-${{ hashFiles('poetry.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-poetry-
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run pytest

README.md

@@ -1,38 +1,39 @@
 # Sunglass
+[![CI](https://github.com/qpv-research-group/sunglass/actions/workflows/ci.yml/badge.svg)](https://github.com/qpv-research-group/sunglass/actions/workflows/ci.yml)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/qpv-research-group/sunglass/develop.svg)](https://results.pre-commit.ci/latest/github/qpv-research-group/sunglass/develop)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Sunglass is a simple - and not yet fully operational - graphical user interface for the
-solar cells and semiconductors modelling framework [Solcore](https://www.solcore.solar/). 
+solar cells and semiconductors modelling framework [Solcore](https://www.solcore.solar/).
 
 ## Using Sunglass
 
-1. Install it from PyPI
+* Install it from PyPI
 
 ```bash
 pip install sunglass
 ```
 
-2. If you want PDD support in Solcore, re-install Solcore with that support:
+* If you want PDD support in Solcore, re-install Solcore with that support:
 
 ```bash
 pip install --no-deps --force-reinstall --install-option="--with_pdd" solcore
 ```
 
-3. Run it!
+* Run it!
 
 ```bash
 python -m sunglass
 ```
 
 ## Develop Sunglass
 
-1. Install poetry following the instructions for your OS: https://python-poetry.org/docs/
-2. `git clone` this repository.
-3. Navigate to thee root folder and install sunglass with `poetry install`
-4. If you want PDD support in Solcore, re-install Solcore with that support:
+* Install poetry following the instructions for your OS: <https://python-poetry.org/docs/>.
+* Clone this repository with `git clone`.
+* Navigate to thee root folder and install sunglass with `poetry install`.
+* If you want PDD support in Solcore, re-install Solcore with that support.
 
 ```bash
 pip install --no-deps --force-reinstall --install-option="--with_pdd" solcore
@@ -50,6 +51,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center"><a href="https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/research-software-engineering/"><img src="https://avatars.githubusercontent.com/u/6095790?v=4?s=100" width="100px;" alt="Diego Alonso Álvarez"/><br /><sub><b>Diego Alonso Álvarez</b></sub></a><br /><a href="#infra-dalonsoa" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#ideas-dalonsoa" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-dalonsoa" title="Maintenance">🚧</a> <a href="https://github.com/qpv-research-group/sunglass/commits?author=dalonsoa" title="Code">💻</a> <a href="https://github.com/qpv-research-group/sunglass/issues?q=author%3Adalonsoa" title="Bug reports">🐛</a></td>
       <td align="center"><a href="https://www.qpvgroup.org/phoebe-pearce"><img src="https://avatars.githubusercontent.com/u/25822065?v=4?s=100" width="100px;" alt="Phoebe Pearce"/><br /><sub><b>Phoebe Pearce</b></sub></a><br /><a href="https://github.com/qpv-research-group/sunglass/pulls?q=is%3Apr+reviewed-by%3Aphoebe-p" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/qpv-research-group/sunglass/issues?q=author%3Aphoebe-p" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/AlexNDRmac"><img src="https://avatars.githubusercontent.com/u/29776808?v=4?s=100" width="100px;" alt="Oleksandr Andriiako"/><br /><sub><b>Oleksandr Andriiako</b></sub></a><br /><a href="#infra-AlexNDRmac" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/qpv-research-group/sunglass/commits?author=AlexNDRmac" title="Tests">⚠️</a></td>
     </tr>
   </tbody>
 </table>