Skip to content

Commit

Permalink
Add reference to cashocs applications website
Browse files Browse the repository at this point in the history
  • Loading branch information
sblauth committed Oct 23, 2023
1 parent 32037e0 commit 91f356b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@

|
cashocs is a computational adjoint-based shape optimization and optimal control
software for python.
cashocs is a finite element software for the automated solution of shape optimization and optimal control problems. It is used to solve problems in fluid dynamics and multiphysics contexts. Its name is an acronym for computational adjoint-based shape optimization and optimal control software and the software is written in Python.


.. contents:: :local:

Expand All @@ -53,6 +53,8 @@ cashocs is based on the finite element package `FEniCS
to treat general PDE constrained optimization problems, in particular, shape
optimization and optimal control problems.

For some applications and further information about cashocs, we also refer to the website `Fluid Dynamical Shape Optimization with cashocs <https://www.itwm.fraunhofer.de/en/departments/tv/products-and-services/shape-optimization-cashocs-software.html>`_.

.. readme_start_disclaimer
Note, that we assume that you are (at least somewhat) familiar with PDE
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Documentation of cashocs
========================

cashocs is a software for solving PDE constrained optimization problems in the fields of shape optimization and optimal control.
cashocs is a finite element software for the automated solution of shape optimization and optimal control problems. It is used to solve problems in fluid dynamics and multiphysics contexts. Its name is an acronym for computational adjoint-based shape optimization and optimal control software and the software is written in Python.

.. toctree::
:maxdepth: 1
Expand All @@ -26,9 +26,9 @@ cashocs is a software for solving PDE constrained optimization problems in the f

**Useful links**:
:ref:`Installation <installation_instructions>` |
`Source Repository <https://github.com/sblauth/cashocs>`_ |
`Issues <https://github.com/sblauth/cashocs/issues>`_ |
`Source Code <https://github.com/sblauth/cashocs>`_ |
:ref:`Tutorial <tutorial_index>` |
`Applications <https://www.itwm.fraunhofer.de/en/departments/tv/products-and-services/shape-optimization-cashocs-software.html>`_ |
:ref:`Config File Documentation <config_shape_optimization>`

.. grid:: 2
Expand Down

0 comments on commit 91f356b

Please sign in to comment.