Metadata-Version: 2.1
Name: cashocs
Version: 1.1.1
Summary: Computational Adjoint-Based Shape Optimization and Optimal Control Software
Home-page: https://github.com/sblauth/cashocs
Author: Sebastian Blauth
Author-email: sebastian.blauth@itwm.fraunhofer.de
License: UNKNOWN
Project-URL: Source, https://github.com/sblauth/cashocs
Project-URL: Documentation, https://cashocs.readthedocs.io/en/latest/index.html
Project-URL: Tutorial, https://cashocs.readthedocs.io/en/latest/tutorial_index.html
Project-URL: Tracker, https://github.com/sblauth/cashocs/issues
Description: CASHOCS
        =======
        
        .. image:: https://img.shields.io/pypi/v/cashocs
            :target: https://pypi.org/project/cashocs/
            :alt: pypi
        
        .. image:: https://anaconda.org/conda-forge/cashocs/badges/version.svg
            :target: https://anaconda.org/conda-forge/cashocs
        
        .. image:: https://anaconda.org/conda-forge/cashocs/badges/installer/conda.svg
            :target: https://conda.anaconda.org/conda-forge
        
        .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.4282513.svg
            :target: https://doi.org/10.5281/zenodo.4282513
        
        .. image:: https://readthedocs.org/projects/cashocs/badge/?version=latest
            :target: https://cashocs.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/pypi/l/cashocs
            :target: https://pypi.org/project/cashocs/
            :alt: license
        
        
        CASHOCS is a computational adjoint-based shape optimization and optimal control
        software for python.
        
        CASHOCS is based on the finite element package `FEniCS
        <https://fenicsproject.org>`__ and uses its high-level unified form language UFL
        to treat general PDE constrained optimization problems, in particular, shape
        optimization and optimal control problems.
        
        .. readme_start_disclaimer
        
        Note, that 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
            - `Hinze, Ulbrich, Ulbrich, and Pinnau, Optimization with PDE Constraints <https://doi.org/10.1007/978-1-4020-8839-1>`_
            - `Tröltzsch, Optimal Control of Partial Differential Equations <https://doi.org/10.1090/gsm/112>`_
        - Shape Optimization
            - `Delfour and Zolesio, Shapes and Geometries <https://doi.org/10.1137/1.9780898719826>`_
            - `Sokolowski and Zolesio, Introduction to Shape Optimization <https://doi.org/10.1007/978-3-642-58106-9>`_
        - FEniCS
            - `Logg, Mardal, and Wells, Automated Solution of Differential Equations by the Finite Element Method <https://doi.org/10.1007/978-3-642-23099-8>`_
            - `The FEniCS demos <https://fenicsproject.org/docs/dolfin/latest/python/demos.html>`_
        
        .. readme_end_disclaimer
        
        However, the `CASHOCS tutorial <https://cashocs.readthedocs.io/en/latest/tutorial_index.html>`_ also gives many references either
        to the underlying theory of PDE constrained optimization or to relevant demos
        and documentation of FEniCS.
        
        Note, that the full CASHOCS documentation is available at `<https://cashocs.readthedocs.io/en/latest/index.html>`_.
        
        
        .. readme_start_installation
        
        Installation
        ============
        
        Via conda-forge
        ---------------
        
        CASHOCS is available via the anaconda package manager, and you can install it
        with ::
        
            conda install -c conda-forge cashocs
        
        Alternatively, you might want to create a new, clean conda environment with the
        command ::
        
            conda create -n <ENV_NAME> -c conda-forge cashocs
        
        where <ENV_NAME> is the desired name of the new environment.
        
        .. note::
        
            `Gmsh <https://gmsh.info/>`_ is not automatically installed with anaconda, as this is not intrinsically
            linked to CASHOCS. Instead, cashocs only provides an interface for importing meshes
            generated with Gmsh. If you want to use Gmsh with cashocs, please use Gmsh 4.6 or higher.
            See `<https://gmsh.info/>`_ for possibilities to install Gmsh.
        
        
        
        Manual Installation
        -------------------
        
        - First, install `FEniCS <https://fenicsproject.org/download/>`__, version 2019.1.
          Note, that FEniCS should be compiled with PETSc and petsc4py.
        
        - Then, install `meshio <https://github.com/nschloe/meshio>`_, with a `h5py <https://www.h5py.org>`_
          version that matches the HDF5 version used in FEniCS, and `matplotlib <https://matplotlib.org/>`_.
          The version of meshio should be at least 4, but for compatibility it is recommended to use meshio 4.2.
        
        - You might also want to install `Gmsh <https://gmsh.info/>`_, version 4.6.
          CASHOCS does not necessarily need this to function properly,
          but it is required for the remeshing functionality.
        
        .. note::
        
            If you are having trouble with using the conversion tool cashocs-convert from
            the command line, then you most likely encountered a problem with hdf5 and h5py.
            This can (hopefully) be resolved by following the suggestions from `this thread
            <https://fenicsproject.discourse.group/t/meshio-convert-to-xdmf-from-abaqus-raises-version-error-for-h5py/1480>`_,
            i.e., you should try to install `meshio <https://github.com/nschloe/meshio>`_
            using the command ::
        
                pip3 install meshio[all] --no-binary=h5py
        
        - You can install CASHOCS via the `PYPI <https://pypi.org/>`_::
        
                pip3 install cashocs
        
          You can install the newest (development) version of CASHOCS with::
        
                pip3 install git+https://github.com/sblauth/cashocs.git
        
        - To 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
                pip3 install .
        
        
        .. note::
        
            To verify that the installation was successful, run the tests for CASHOCS
            with ::
        
                cd tests
                python3 -m pytest
        
            from the source / repository root directory. Note, that it might take some
            time to perform all of these tests for the very first time, as FEniCS
            compiles the necessary code. However, on subsequent iterations the
            compiled code is retrieved from a cache, so that the tests are singificantly
            faster.
        
        
        .. readme_end_installation
        
        
        Usage
        =====
        
        The complete CASHOCS documentation is available here `<https://cashocs.readthedocs.io/en/latest/index.html>`_. For a detailed
        introduction, see the `CASHOCS tutorial <https://cashocs.readthedocs.io/en/latest/tutorial_index.html>`_. The python source code
        for the demo programs is located inside the "demos" folder.
        
        
        .. readme_start_license
        .. _license:
        
        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/>`_.
        
        
        .. readme_end_license
        
        
        .. readme_start_about
        
        Contact / About
        ===============
        
        I'm Sebastian Blauth, a PhD student at `Fraunhofer ITWM
        <https://www.itwm.fraunhofer.de/en.html>`_ and `TU Kaiserslautern
        <https://www.mathematik.uni-kl.de/en/>`_, and I developed this project as part of my work.
        If you have any questions / suggestions / feedback, etc., you can contact me
        via `sebastian.blauth@itwm.fraunhofer.de
        <mailto:sebastian.blauth@itwm.fraunhofer.de>`_ or `sebastianblauth@web.de
        <mailto:sebastianblauth@web.de>`_.
        
        .. readme_end_about
        
Keywords: Computational Adjoint-Based Shape Optimization and Optimal Control Software
Platform: UNKNOWN
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
