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.
Introduction
cashocs is based on the finite element package FEniCS and uses its high-level unified form language UFL to treat general PDE constrained optimization problems, in particular, shape optimization and optimal control problems.
To get started with cashocs, take a look at cashocs in a nutshell as well as the in-depth tutorial. There, the core concepts and functionalities of cashocs are explained.
An overview over cashocs and its capabilities can be found in Blauth - cashocs: A Computational, Adjoint-Based Shape Optimization and Optimal Control Software and Blauth - Version 2.0 - cashocs: A Computational, Adjoint-Based Shape Optimization and Optimal Control Software. Moreover, note that the full cashocs documentation is available at https://cashocs.readthedocs.io.
For some applications and further information about cashocs, we also refer to the website Fluid Dynamical Shape Optimization with cashocs.
Installation
Via conda-forge
cashocs is available via the conda package manager, and you can install it (to your currently activated environment) with
conda install -c conda-forge cashocsAlternatively, you might want to create a new, clean conda environment with the command
conda create -n ENV_NAME -c conda-forge cashocswhere ENV_NAME is the desired name of the new environment.
For more information about conda, please take a look at the conda documentation.
Manual Installation
First, install FEniCS, version 2019.1. Note that FEniCS should be compiled with PETSc and petsc4py. Moreover, note that cashocs is not yet compatible with the new dolfinx, which is currently under development.
Then, install meshio, with a h5py version that matches the HDF5 version used in FEniCS, and matplotlib. The version of meshio should be at least 4, but for compatibility it is recommended to use meshio 4.4.
You might also want to install Gmsh, version 4.8 or later. cashocs does not necessarily need this to work properly, but it is required for the remeshing functionality.
You can install cashocs via the PYPI as follows
pip install cashocsYou can install the newest (development) version of cashocs with
pip install git+https://github.com/sblauth/cashocs.gitTo get the latest (development) version of cashocs, clone this repository with git and install it with pip
git clone https://github.com/sblauth/cashocs.git cd cashocs pip install .
Usage
The complete cashocs documentation is available here https://cashocs.readthedocs.io. For a detailed introduction, see the cashocs tutorial. The python source code for the demo programs is located inside the “demos” folder.
Citing
If you use cashocs for your research, please cite the following paper
cashocs: A Computational, Adjoint-Based Shape Optimization and Optimal Control Software
Sebastian Blauth
SoftwareX, Volume 13, 2021
https://doi.org/10.1016/j.softx.2020.100646or use the following bibtex entry
@Article{Blauth2021cashocs,
author = {Sebastian Blauth},
journal = {SoftwareX},
title = {{cashocs: A Computational, Adjoint-Based Shape Optimization and Optimal Control Software}},
year = {2021},
issn = {2352-7110},
pages = {100646},
volume = {13},
doi = {https://doi.org/10.1016/j.softx.2020.100646},
keywords = {PDE constrained optimization, Adjoint approach, Shape optimization, Optimal control},
}For more details on how to cite cashocs please take a look at https://cashocs.readthedocs.io/en/stable/about/citing/.
References for PDE Constrained Optimization and FEniCS
We assume that you are (at least somewhat) familiar with PDE constrained optimization and FEniCS. For a introduction to these topics, we can recommend the textbooks
- Optimal Control and general PDE constrained optimization
License
cashocs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
cashocs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with cashocs. If not, see https://www.gnu.org/licenses/.
Contact / About
I’m Sebastian Blauth, a researcher at Fraunhofer ITWM. I started developing cashocs during my PhD studies and have further developed and refined it as part of my employment at Fraunhofer ITWM. If you have any questions / suggestions / feedback, etc., you can contact me via sebastian.blauth@itwm.fraunhofer.de. For more information, visit my website at https://sblauth.github.io/.
1 maintainer
Release files for cashocs 2.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cashocs-2.10.1.tar.gz | 310.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cashocs-2.10.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 784.2 kB
Release files / cashocs-2.10.1.tar.gz
| Download URL | cashocs-2.10.1.tar.gz |
|---|---|
| Size | 310.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
48a3ba0a5241d04e0843f3f82b3557eaeb3c99fa74a16a18b4ad7be3f1d1dbbc
|
|
BLAKE2b-256 checksum How to use checksums |
5f88cab7c89798404052526c7651bac726831276dd7e644b892197f76bb863c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency logRelease files / cashocs-2.10.1-py3-none-any.whl
| Download URL | cashocs-2.10.1-py3-none-any.whl |
|---|---|
| Size | 473.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ce0ab5b94100e1b0e5b4ff9e09f0eaf25f3cdfafd60f54e881b187beb14487c0
|
|
BLAKE2b-256 checksum How to use checksums |
5ec9f0a88b0e667fab067f199258c138d49b577ba22e99645458615ed0d6863b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency log
