https://github.com/geodynamics/aspect
Raw File
Tip revision: deac43333fd64a3444b7f72b13cdc5aae29582db authored by Timo Heister on 13 May 2016, 17:08:40 UTC
release task: update version info
Tip revision: deac433
readme.html
<html>
  <head>
    <title>ASPECT README</title>
    <link href="screen.css" type="text/css" rel="StyleSheet" />
    <meta name="author" content="Wolfgang Bangerth, Timo Heister" />
    <meta name="copyright" content="Copyright (C) 2015 by the ASPECT authors" />
  </head>

  <body>

    <h1 align="center">
    ReadMe instructions for <abbr>ASPECT</abbr>
    </h1>

	    <p> <abbr>ASPECT</abbr> is published under the <a href="doc/COPYING">GNU GPL v2 or newer license.</a>
	    </p>

	    <h3>
	      Installation instructions
	    </h3>

	    <p>
	      In order to install <abbr>ASPECT</abbr>, you will need to first install the following
	      dependencies:
	      <ul>
		<li><a href="http://trilinos.org/">Trilinos</a>: A library for
		  parallel linear algebra.
		<li><a href="http://www.p4est.org">p4est</a>: A library for
		  parallel data structures and algorithms to represent meshes.
		<li><a href="https://www.dealii.org">deal.II</a>: A library that
		  supports all things related to finite element methods.
	      </ul>
	      The individual steps needed to install each of these packages are
	      discussed in the <a href="http://www.math.clemson.edu/~heister/manual.pdf">Installation instructions
		section of the <abbr>ASPECT</abbr> manual</a>.
	      Detailed installation instructions are also provided by all of these
	      libraries on their webpages as well as <i>much</i> more information
	      about details of these libraries.
	    </p>

	    <p>
	      One you have installed these three underlying libraries, compiling
	      <abbr>ASPECT</abbr> is relatively simple. More information can again be found in the
	      corresponding section of the <a href="http://www.math.clemson.edu/~heister/manual.pdf"><abbr>ASPECT</abbr> manual</a>.
	    </p>


	    <h3>
	      Running and extending <abbr>ASPECT</abbr>
	    </h3>

	    <p>
	      Instructions on how to run and extend, as well as on how to interpret
	      the output of ASPECT can also be found in
	      the <a href="http://www.math.clemson.edu/~heister/manual.pdf"><abbr>ASPECT</abbr> manual</a>. This manual also
	      discusses the structure of the source code.
	    </p>


	    <a name="mailinglists"></a>
	    <h3>
	      More information
	    </h3>

	    <p>
	      If you have questions on <abbr>ASPECT</abbr>, there are a number of mailing lists
	      that can help:
	      <ul>
		<li>The ASPECT website is available at <a href="https://aspect.dealii.org">http://aspect.dealii.org</a>
		<li>For questions on the source code of <abbr>ASPECT</abbr>, portability,
		  installation, etc., use
		  the <a href="http://lists.geodynamics.org/cgi-bin/mailman/listinfo/aspect-devel">aspect-devel mailing
		    list</a>. This mailing list is where the <abbr>ASPECT</abbr>
		  developers all hang out.

		<li><abbr>ASPECT</abbr> is primarily based on the deal.II library (the dependency
		  on Trilinos and p4est is primarily through deal.II, and not directly
		  visible in the <abbr>ASPECT</abbr> source code). If you have particular questions
		  about deal.II, contact
		  the <a href="https://www.dealii.org/mail.html">deal.II discussion groups</a>.

		<li>In case of more general questions about mantle convection, you can
		  contact the <a href="http://lists.geodynamics.org/cgi-bin/mailman/listinfo/cig-MC">CIG mantle
		    convection mailing lists</a>.

		<li>If you have specific questions about <abbr>ASPECT</abbr> that are not suitable
		  for public and archived mailing lists, you can contact the
		  primary developers:
		  <ul>
		    <li>Wolfgang
		      Bangerth: <a href="mailto:bangerth@math.tamu.edu">bangerth@math.tamu.edu</a>
		    <li>Timo
		      Heister: <a href="mailto:heister@clemson.edu">heister@clemson.edu</a>
		  </ul>
	      </ul>
	    </p>

  </body>
</html>
back to top