Skip to content

Commit

Permalink
Merge pull request #61 from zjwegert/zjwegert-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
zjwegert authored May 15, 2024
2 parents 43911c3 + 1197397 commit 9b72710
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
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`.

0 comments on commit 9b72710

Please sign in to comment.