Skip to content

Commit 911f6cf

Browse files
committed
Update README
1 parent 420ea64 commit 911f6cf

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ Solvers follow a modular design, where most blocks can be combined to produce PD
1919
- **Geometric Multigrid**: We provide a full-fledged geometric multigrid solver. Highly scalable adaptivity and redistribution of meshes, provided by `p4est` through `GridapP4est.jl`.
2020
- **PETSc interface**: Full access to PETSc algebraic solvers, through `GridapPETSc.jl`, with full interoperability with the rest of the aforementioned solvers.
2121

22+
## Documentation and examples
23+
24+
A (hopefully) comprehensive documentation is available at [https://gridap.github.io/GridapSolvers.jl/stable/](https://gridap.github.io/GridapSolvers.jl/stable/).
25+
26+
A list of examples is available in the documentation. These include some very well known examples such as the Stokes, Incompressible Navier-Stokes and Darcy problems. The featured scripts are available in `test/Applications`.
27+
28+
An example on how to use the library within an HPC cluster is available in `joss_paper/scalability`. The included example and drivers are used to generate the scalability results in our [JOSS paper](https://doi.org/10.21105/joss.07162).
29+
2230
## Installation
2331

2432
GridapSolvers is a registered package in the official [Julia package registry](https://github.com/JuliaRegistries/General). Thus, the installation of GridapSolvers is straight forward using the [Julia's package manager](https://julialang.github.io/Pkg.jl/v1/). Open the Julia REPL, type `]` to enter package mode, and install as follows
@@ -40,4 +48,29 @@ The previous installations steps will setup GridapSolvers to work using Julia's
4048

4149
## Citation
4250

43-
In order to give credit to the `GridapSolvers` contributors, we ask that you please reference our [JOSS paper](https://joss.theoj.org/papers/10.21105/joss.07162) along with the required citations for [Gridap](https://github.com/gridap/Gridap.jl?tab=readme-ov-file#how-to-cite-gridap).
51+
In order to give credit to the `GridapSolvers` contributors, we simply ask you to cite the `Gridap` main project as indicated [here](https://github.com/gridap/Gridap.jl#how-to-cite-gridap) and the sub-packages you use as indicated in the corresponding repositories. Please, use the reference below in any publication in which you have made use of `GridapSolvers`:
52+
53+
```
54+
@article{Manyer2024,
55+
doi = {10.21105/joss.07162},
56+
url = {https://doi.org/10.21105/joss.07162},
57+
year = {2024},
58+
publisher = {The Open Journal},
59+
volume = {9},
60+
number = {102},
61+
pages = {7162},
62+
author = {Jordi Manyer and Alberto F. Martín and Santiago Badia},
63+
title = {GridapSolvers.jl: Scalable multiphysics finite element solvers in Julia},
64+
journal = {Journal of Open Source Software}
65+
}
66+
```
67+
68+
## Contributing
69+
70+
GridapSolvers is a collaborative project open to contributions. If you want to contribute, please take into account:
71+
72+
- Before opening a PR with a significant contribution, contact the project administrators by [opening an issue](https://github.com/gridap/GridapSolvers.jl/issues/new) describing what you are willing to implement. Wait for feedback from other community members.
73+
- We adhere to the contribution and code-of-conduct instructions of the Gridap.jl project, available [here](https://github.com/gridap/Gridap.jl/blob/master/CONTRIBUTING.md) and [here](https://github.com/gridap/Gridap.jl/blob/master/CODE_OF_CONDUCT.md), resp. Please, carefully read and follow the instructions in these files.
74+
- Open a PR with your contribution.
75+
76+
Want to help? We have [issues waiting for help](https://github.com/gridap/GridapSolvers.jl/labels/help%20wanted). You can start contributing to the GridapSolvers project by solving some of those issues.

0 commit comments

Comments
 (0)