|
1 | 1 | # PETSC
|
2 | 2 |
|
3 |
| -[](https://fverdugo.github.io/PETSC.jl/stable/) |
4 |
| -[](https://fverdugo.github.io/PETSC.jl/dev/) |
5 |
| -[](https://github.com/fverdugo/PETSC.jl/actions/workflows/CI.yml?query=branch%3Amain) |
6 |
| -[](https://codecov.io/gh/fverdugo/PETSC.jl) |
| 3 | +This package provides easy access to PETSc solvers in sequential and parallel Julia computations. |
| 4 | + |
| 5 | + |
| 6 | +| **Documentation** | |
| 7 | +|:------------ | |
| 8 | +| [](https://fverdugo.github.io/PETSC.jl/stable/) | |
| 9 | +| [](https://fverdugo.github.io/PETSC.jl/dev/) | |
| 10 | +|**Build Status** | |
| 11 | +[](https://github.com/fverdugo/PETSC.jl/actions/workflows/CI.yml?query=branch%3Amain) | |
| 12 | +|**Coverage** | |
| 13 | +| [](https://codecov.io/gh/fverdugo/PETSC.jl) | |
| 14 | + |
| 15 | +## Documentation |
| 16 | + |
| 17 | +- [**STABLE**](https://fverdugo.github.io/PETSC.jl/stable) — **Documentation for the most recently tagged version.** |
| 18 | +- [**LATEST**](https://fverdugo.github.io/PETSC.jl/dev) — *Documentation for the in-development version.* |
| 19 | + |
| 20 | +## Help and discussion |
| 21 | + |
| 22 | +- You can open a new discussion to ask questions [here](https://github.com/fverdugo/PETSC.jl/discussions). |
| 23 | +- If you have found a bug, open an issue [here](https://github.com/fverdugo/PETSC.jl/issues). Do not forget to include a (minimal) reproducer. |
| 24 | + |
| 25 | +## Contributing |
| 26 | + |
| 27 | +This package is under active development and there are several ways to contribute: |
| 28 | + |
| 29 | +- by enhancing the documentation (e.g., fixing typos, enhancing doc strings, adding examples). |
| 30 | +- by addressing one of the [issues waiting for help](https://github.com/fverdugo/PETSC.jl/labels/help%20wanted). |
| 31 | +- by adding more tests to increase the code coverage. |
| 32 | +- by extending the current functionality. In this case, open a discussion [here](https://github.com/fverdugo/PETSC.jl/discussions) to coordinate with the package maintainers before proposing significant changes. |
0 commit comments