From 37cf9b06e6880c6445b40abc16d8272b3a976aa5 Mon Sep 17 00:00:00 2001 From: Andreas Kloeckner Date: Mon, 8 Aug 2016 11:49:01 -0500 Subject: [PATCH] Add misc doc section --- doc/index.rst | 1 + doc/misc.rst | 79 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) create mode 100644 doc/misc.rst diff --git a/doc/index.rst b/doc/index.rst index f652d1b..4bde9b2 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,6 +8,7 @@ Contents: mesh discretization + misc Indices and tables ================== diff --git a/doc/misc.rst b/doc/misc.rst new file mode 100644 index 0000000..488262a --- /dev/null +++ b/doc/misc.rst @@ -0,0 +1,79 @@ +.. _installation: + +Installation +============ + +This command should install :mod:`meshmode`:: + + pip install meshmode + +(Note the extra "."!) + +You may need to run this with :command:`sudo`. +If you don't already have `pip `_, +run this beforehand:: + + curl -O https://raw.github.com/pypa/pip/master/contrib/get-pip.py + python get-pip.py + +For a more manual installation, `download the source +`_, unpack it, and say:: + + python setup.py install + +You may also clone its git repository:: + + git clone --recursive git://github.com/inducer/meshmode + git clone --recursive http://git.tiker.net/trees/meshmode.git + +User-visible Changes +==================== + +Version 2016.1 +-------------- +.. note:: + + This version is currently under development. You can get snapshots from + meshmode's `git repository `_ + +.. _license: + +Licensing +========= + +:mod:`meshmode` is licensed to you under the MIT/X Consortium license: + +Copyright (c) 2014-16 Andreas Klöckner and Contributors. + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +Acknowledgments +=============== + +Andreas Klöckner's work on :mod:`meshmode` was supported in part by + +* US Navy ONR grant number N00014-14-1-0117 +* the US National Science Foundation under grant numbers DMS-1418961 and CCF-1524433. + +AK also gratefully acknowledges a hardware gift from Nvidia Corporation. The +views and opinions expressed herein do not necessarily reflect those of the +funding agencies. -- GitLab