# oomph-lib

**Repository Path**: libo4me/oomph-lib

## Basic Information

- **Project Name**: oomph-lib
- **Description**: No description available
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: development
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-22
- **Last Updated**: 2021-11-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
  <a href="http://oomph-lib.maths.man.ac.uk">
    <img alt="reviewdog" src="./doc/figures/oomph_logo.png">
  </a>
</div>

<div align="center">
  <a href="./LICENCE">
    <img alt="License: LGPL v2.1" src="https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg">
  </a>
  <a href="../../actions/workflows/build-and-publish-docs.yaml">
    <img alt="Documentation" src="../../actions/workflows/build-and-publish-docs.yaml/badge.svg?branch=main">
  </a>
</div>

<br>

<div align="center">
    <table style="width:55%">
    <tr>
        <th>Test platform</th>
        <th><a href="../../tree/main"><code>main</code></a></th>
        <th><a href="../../tree/development"><code>development</code></a></th>
    </tr>
    <tr>
        <td>Ubuntu</td>
        <td>
            <a href="../../actions/workflows/self-tests-ubuntu.yaml">
                <img alt="Ubuntu" src="../../actions/workflows/self-tests-ubuntu.yaml/badge.svg?branch=main">
            </a>
        </td>
        <td>
            <a href="../../actions/workflows/self-tests-ubuntu.yaml">
                <img alt="Ubuntu" src="../../actions/workflows/self-tests-ubuntu.yaml/badge.svg?branch=development">
            </a>
        </td>
    </tr>
    <tr>
        <td>macOS</td>
        <td>
            <a href="../../actions/workflows/self-tests-macos.yaml">
                <img alt="macOS" src="../../actions/workflows/self-tests-macos.yaml/badge.svg?branch=main">
            </a>
        </td>
        <td>
            <a href="../../actions/workflows/self-tests-macos.yaml">
                <img alt="macOS" src="../../actions/workflows/self-tests-macos.yaml/badge.svg?branch=development">
            </a>
        </td>
    </tr>
    </table>
</div>

## Description

Please consult the file [`INSTALL.md`](INSTALL.md) in this directory for
installation instructions.

The [`oomph-lib` homepage](http://www.oomph-lib.org) provides much more detail on
installation instructions, tutorials, and licencing information. Provided you
have downloaded a distribution that contains the documentation and you have the
required tools (mainly `doxygen`; get it from [here](http://www.doxygen.org))
available on your machine, the installation procedure will create a local copy
of the `oomph-lib` webpages and the entire online documentation in the `doc`
directory. In particular, `doc/html/index.html` is a local copy of the `oomph-lib`
homepage.

To learn more about contributing to `oomph-lib`, please see
[`CONTRIBUTING.md`](CONTRIBUTING.md).


## Community

The original "architects" of `oomph-lib` (in alphabetical order) are
[**Andrew Hazel**](https://github.com/alhazel) (**co-founder**) &
[**Matthias Heil**](https://github.com/MatthiasHeilManchester) (**co-founder**).
Alongside the library founders, `oomph-lib` is currently maintained with the
help of [**Jonathan Deakin**](https://github.com/jondea) and
[**Puneet Matharu**](https://github.com/PuneetMatharu). However, the library has
received (and is still receiving) significant contributions from former/current
project/MSc/PhD students and collaborators. For an exhaustive list, see
[`CONTRIBUTORS.md`](CONTRIBUTORS.md).

If you're interested in joining the team, get in touch. We're always looking for
more help!