Skip to content
Snippets Groups Projects
Commit 7bc4f6d6 authored by Steffen Müthing's avatar Steffen Müthing
Browse files

[Documentation] Update documentation and add copyright and license

parent 37056f8c
No related branches found
No related tags found
No related merge requests found
BSD 0 → 100644
Copyright (c) 2009--2012, Peter Bastian, Markus Blatt, Christian Engwer, Jorrit
Fahlke, Felix Heimann, Ole Klein, Sven Marnach, Steffen Müthing, Rebecca
Neumann, Adrian Ngo, Jurgis Pods, Dan Popovic, Hanna Remmel
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of the Universität Heidelberg nor the names of its
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
CC-BY-SA 0 → 100644
This diff is collapsed.
LICENSE.md
\ No newline at end of file
Licensing Information
=====================
Copyright holders
-----------------
| Year | Name |
|------------|---------------------------------|
| 2015--2016 | Peter Bastian |
| 2015--2016 | René Heß |
| 2015--2016 | Dominic Kempf |
| 2015--2016 | Ole Klein |
| 2016 | Piotr Minakowski |
| 2015--2016 | Steffen Müthing |
| 2015--2016 | Marian Piatkowski |
License
-------
The example programs contained in this package are copyrighted free software. You
can use, modify and/or redistribute it under the terms of the BSD 3-clause licencse,
which you can find in the file [BSD][1].
The documentation, tutorials and exercise sheet contained in this package (typically
found in `doc/` subfolders) are licensed under the Creative Commons Attribution-ShareAlike
3.0 Unported License. You can find a copy of this license in the file [CC-BY-SA][2]. If not,
see http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative Commons,
444 Castro Street, Suite 900, Mountain View, California, 94041, USA.
Note that all of the code examples in the documentation can also be found in the
source code for the example programs and are thus licensed under the terms of both licenses.
Links
-----
[1]: BSD
[2]: CC-BY-SA
Preparing the Sources
=========================
Additional to the software mentioned in README you'll need the
following programs installed on your system:
cmake >= 2.8.12
Getting started
---------------
If these preliminaries are met, you should run
dunecontrol all
which will find all installed dune modules as well as all dune modules
(not installed) which sources reside in a subdirectory of the current
directory. Note that if dune is not installed properly you will either
have to add the directory where the dunecontrol script resides (probably
./dune-common/bin) to your path or specify the relative path of the script.
Most probably you'll have to provide additional information to dunecontrol
(e. g. compilers, configure options) and/or make options.
The most convenient way is to use options files in this case. The files
define four variables:
CMAKE_FLAGS flags passed to cmake (durin configure)
MAKE_FLAGS flags passed to make
An example options file might look like this:
#use this options to autogen, configure and make if no other options are given
CMAKE_FLAGS=" \
-DCMAKE_CXX_COMPILER=g++-4.9 \
-DCMAKE_CXX_FLAGS='-Wall -pedantic' \
-DCMAKE_INSTALL_PREFIX=/install/path" #Force g++-4.9 and set compiler flags
MAKE_FLAGS=install #Per default run make install instead of simply make
If you save this information into example.opts you can pass the opts file to
dunecontrol via the --opts option, e. g.
dunecontrol --opts=example.opts all
More info
---------
See
dunecontrol --help
for further options.
The full build-system is described in the dune-common/doc/buildsystem (Git version) or under share/doc/dune-common/buildsystem if you installed DUNE!
PDELab
======
This is the development version of the dune-pdelab tutorials.
[PDELab][0] is a PDE solver toolbox built on top of DUNE, the [Distributed and Unified
Numerics Environment][1].
This package contains a number of individual tutorials that present different aspects of
the PDELab framework.
If you need help, please ask on our [mailinglist][2]. Bugs can also be submitted
to the PDELab [bugtracker][3] instead.
Dependencies
------------
The current development version of dune-pdelab-tutorials depends on the following software:
* PDELab and DUNE core libraries (dune-common, dune-geometry, dune-grid, dune-istl,
dune-localfunctions, dune-typetree, dune-pdelab) version 2.4.1, and their respective
dependencies.
* The [UG][4] grid library. Note that it has to be configured for parallel computations
and that the dune-grid module has to be compiled with the UG bindings.
* The [dune-alugrid][5] library (specifically the releases/2.4 branch), and its respective
dependencies.
* A compiler with support for C++14, at least GCC 4.9 or clang 3.5.
* CMake 3.1.
License
-------
All of the contained tutorials and example programs are free open-source documentation
and software.
See the file [LICENSE.md][6] for full copying permissions.
Installation
------------
For installation instructions please see the [DUNE website][1].
Links
-----
[0]: http://www.dune-project.org/pdelab/
[1]: http://www.dune-project.org
[2]: http://lists.dune-project.org/mailman/listinfo/dune-pdelab
[3]: https://gitlab.dune-project.org/pdelab/dune-pdelab-tutorials/issues
[4]: https://gitlab.dune-project.org/ug/ug
[5]: https://gitlab.dune-project.org/extensions/dune-alugrid
[4]: LICENSE.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment