-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/zjwegert/LSTO_Distributed
- Loading branch information
Showing
1 changed file
with
3 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,16 @@ | ||
# GridapTopOpt | ||
|
||
| **badges** | | ||
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://zjwegert.github.io/GridapTopOpt.jl/stable) [![Build Status](https://github.com/zjwegert/GridapTopOpt.jl/workflows/CI/badge.svg?branch=main)](https://github.com/zjwegert/GridapTopOpt.jl/actions?query=workflow%3ACI) [![Codecov](https://codecov.io/gh/zjwegert/GridapTopOpt.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/zjwegert/GridapTopOpt.jl) | ||
|
||
GridapTopOpt is computational toolbox for level set-based topology optimisation implemented in Julia and the [Gridap](https://github.com/gridap/Gridap.jl) package ecosystem. See the documentation and following publication for further details: | ||
|
||
> Zachary J. Wegert, Jordi Manyer, Connor Mallon, Santiago Badia, and Vivien J. Challis (2024). "GridapTopOpt.jl: A scalable Julia toolbox for level set-based topology optimisation". In preparation. | ||
## Documentation | ||
|
||
- [**STABLE**](...) — **Documentation for the most recently tagged version.** | ||
- [**LATEST**](...) — *Documentation for the in-development version.* | ||
- [**STABLE**](https://zjwegert.github.io/GridapTopOpt.jl/stable) — **Documentation for the most recently tagged version.** | ||
|
||
## Citation | ||
In order to give credit to the `GridapTopOpt` contributors, we ask that you please reference the above paper along with the required citations for [Gridap](https://github.com/gridap/Gridap.jl?tab=readme-ov-file#how-to-cite-gridap). | ||
|
||
## Known issues | ||
- We currently require the `develop` branch of `GridapSolvers` for `GridapTopOpt`. Ensure that this is correctly loaded via `pkg> add GridapSolvers#develop`. | ||
- We currently require the `develop` branch of `GridapSolvers` for `GridapTopOpt`. Ensure that this is correctly loaded via `pkg> add GridapSolvers#develop`. |