JDBetteridge/merge finat gem

.github/workflows/docs.yml

@@ -0,0 +1,36 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build_docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.12
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements.txt
+          python -m pip install sphinx
+      - name: Install
+        run: |
+          python -m pip install .
+      - name: Build docs
+        run: |
+          make -C docs html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          publish_branch: gh-pages
+          enable_jekyll: false
+          allow_empty_commit: false
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.github/workflows/test.yml

@@ -0,0 +1,42 @@
+name: Build and test
+
+on:
+  # Run on pushes to master
+  push:
+    branches:
+      - master
+  # And all pull requests
+  pull_request:
+
+
+jobs:
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+    # Test against multiple Python versions
+    strategy:
+      # Don't immediately kill all if one Python version fails
+      fail-fast: false
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+    # Steps represent a sequence of tasks that will be executed as
+    # part of the jobs
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install -r requirements.txt
+          python -m pip install flake8 pytest
+      - name: Lint
+        run: |
+          python -m flake8 .
+      - name: Install
+        run: |
+          python -m pip install .
+      - name: Test
+        run: |
+          python -m pytest test

.gitignore

@@ -8,4 +8,50 @@
 /doc/sphinx/source/api-doc
 release/
 
-/doc/sphinx/source/_build/
+/doc/sphinx/source/_build/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+/docs/source/finat.rst

.mailmap

@@ -142,3 +142,4 @@ Robert Kirby <[email protected]> kirby <[email protected]>
 Robert Kirby <[email protected]> kirby <[email protected]>
 Robert Kirby <[email protected]> kirby <[email protected]>
 Matthew Knepley <[email protected]> knepley <knepley@knepley-laptop>
+Reuben Nixon-Hill <[email protected]> <[email protected]>

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014-2020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,6 @@
+PYTHONPATH := $(PWD):$(PYTHONPATH)
+
+lint:
+	flake8 .
+
+test: lint

README.md

@@ -0,0 +1,57 @@
+# FInAT: a smarter library of finite elements
+
+Unlike [FIAT](https://github.com/FEniCS/fiat "FInite element Automatic
+Tabulator"), “**F**InAT **I**s **n**ot **A** **T**abulator.”  Instead,
+it provides symbolic expressions for the evaluation of finite
+elements.  Thus FInAT can express the structure that is intrinsic to
+some finite elements, which a form compiler can exploit to
+automatically:
+
+- sum factorise continuous, discontinuous, *H*(div) and *H*(curl)
+  conforming elements on cuboid cells;
+- optimise evaluation at collocated quadrature points when
+  under-integration is requested; and
+- optimise evaluation on vector and tensor elements.
+
+Furthermore, FInAT is equipped to provide symbolic expressions for
+basis transformations when the caller implements an interface capable
+of providing (symbolic expressions for) the required geometric
+quantities (such as Jacobians, normals, or tangents), which
+facilitates the implementation of finite elements such as Hermite,
+Morley, Bell, and Argyris within an automatic code generation
+framework.
+
+The goal of FInAT is to be a “single source of truth” for finite
+elements. This includes not only basis function evaluation, like FIAT,
+but also structural and algorithmic considerations as well as
+reference element transformations.  Symbolic expression languages and
+form compilers can then exploit this information in an
+element-independent manner.
+
+FInAT is integrated with
+[TSFC](https://github.com/firedrakeproject/tsfc "Two-Stage Form
+Compiler") and is a component of
+[Firedrake](https://firedrakeproject.org/), “an automated system for
+the portable solution of partial differential equations using the
+finite element method.”  To facilitate the exchange of symbolic
+expressions between the element library on the one hand, and the form
+compiler on the other, they need to agree on a common language.  Where
+FIAT communicated with the form compiler through numerical arrays,
+FInAT communicates with the form compiler by exchanging GEM
+expressions.  GEM is the intermediate language used in both TSFC and
+FInAT to describe tensor algebra.
+
+## References
+
+1. Miklós Homolya, Robert C. Kirby, and David A. Ham (2017).
+   “Exposing and exploiting structure: optimal code generation for
+   high-order finite element methods.” _arXiv preprint
+   arXiv:1711.02473._
+1. Robert C. Kirby, and Lawrence Mitchell (2019). “Code generation for
+   generally mapped finite elements.” _ACM Transactions on
+   Mathematical Software (TOMS)_, 45(4), pp. 1-23.
+
+## License
+
+All files in this repository are available under the MIT license, see
+the LICENSE file for details.