[Commits] [svn:einsteintoolkit] www/info/documentation/ (Rev. 146)
gallen at cct.lsu.edu
gallen at cct.lsu.edu
Sun Apr 11 14:01:45 CDT 2010
User: gallen
Date: 2010/04/11 02:01 PM
Added:
/info/documentation/
experts.php, list.php, tutorial.php
Modified:
/info/documentation/
index.php
Log:
Split up page of documentation and add list of other relevant publicationS
File Changes:
Directory: /info/documentation/
===============================
File [added]: experts.php
Delta lines: +13 -0
===================================================================
--- info/documentation/experts.php (rev 0)
+++ info/documentation/experts.php 2010-04-11 19:01:45 UTC (rev 146)
@@ -0,0 +1,13 @@
+<?php $title='Information for Cactus Experts';
+include_once($_SERVER['DOCUMENT_ROOT'].'/global/header.php');?>
+
+
+<p>Use <a href="http://cactuscode.org/download/GetCactus">GetCactus</a> with the
+Einstein Toolkit <a href="https://svn.einsteintoolkit.org/manifest/einsteintoolkit.th">thornlist</a>. This thornlist should work on platforms supported by the Cactus team using the usual <a href="http://www.cactuscode.org/download/configfiles/">configuration files</a> available on the Cactus web page or with the <a href="http://www.cct.lsu.edu/~eschnett/SimFactory/">Simulation Factory</a>.
+ Example parameter files are provided in the Einstein Toolkit SVN repository:</p>
+<p><tt>svn checkout https://svn.einsteintoolkit.org/EinsteinExamples/</tt></p>
+<p>
+ Problems should be directed to <a href="mailto:users at einsteintoolkit.org">users at einsteintoolkit.org</a>.
+</p>
+
+<?php include_once($_SERVER['DOCUMENT_ROOT'].'/global/footer.php');?>
Property changes on: info/documentation/experts.php
___________________________________________________________________
Name: svn:executable
+ *
File [modified]: index.php
Delta lines: +5 -86
===================================================================
--- info/documentation/index.php 2010-04-08 13:13:55 UTC (rev 145)
+++ info/documentation/index.php 2010-04-11 19:01:45 UTC (rev 146)
@@ -1,97 +1,16 @@
<?php $title='Documentation';
include_once($_SERVER['DOCUMENT_ROOT'].'/global/header.php');?>
-<p>More documentation will arrive soon, for now we provide brief information for those already familiar with Cactus, and a worked example for beginners.
+<p>More documentation will arrive soon, but for now we have:</p>
-<h3>For Cactus Experts</h3>
-
-<p>Use <a href="http://cactuscode.org/download/GetCactus">GetCactus</a> with the
-Einstein Toolkit <a href="https://svn.einsteintoolkit.org/manifest/einsteintoolkit.th">thornlist</a>. This thornlist should work on platforms supported by the Cactus team using the usual <a href="http://www.cactuscode.org/download/configfiles/">configuration files</a> available on the Cactus web page or with the <a href="http://www.cct.lsu.edu/~eschnett/SimFactory/">Simulation Factory</a>.
- Example parameter files are provided in the Einstein Toolkit SVN repository:</p>
-<p><tt>svn checkout https://svn.einsteintoolkit.org/EinsteinExamples/</tt></p>
-<p>
- Problems should be directed to <a href="mailto:users at einsteintoolkit.org">users at einsteintoolkit.org</a>.
-</p>
-
-<h3>For Cactus Beginners</h3>
-
-<p>This section provides a simple guide for compiling and running an example parameter file for the Einstein Toolkit.</p>
-
-<p>One complexity of high performance computing is the heterogeneous environments presented by different resources with different core software installations and local setups. For example, Einstein Toolkit codes necessitate compiling with MPI and then running the resulting application in a batch queue. As much as possible of this complexity is hidden in Cactus and accompanying tools such as the Simulation Factory.</p>
-
-<p>This worked example assumes that you are using the NSF TeraGrid resource <a href="http://www.loni.org/systems/system.php?system=QueenBee">Queen Bee</a>. If you don't have an existing account on Queen Bee you can <a href="request.php">request an account</a> to use for these examples.</p>
-
-<h4>Prepare some Tools</h4>
-
-<p>On Queen Bee (qb.loni.org), the <tt>git</tt> client will not be in your path by default. To add this type</p>
-<p><tt>soft add +git</tt></p>
-
-<p>Download the <a href="http://cactuscode.org/download/GetComponents">GetComponents</a> script which will checkout all the components of the Einstein Toolkit and ensure it is executable:</p>
-
-<p><tt>wget http://cactuscode.org/download/GetComponents</tt>
-<br>
-<tt>chmod 755 GetComponents</tt></p>
-
-
-<p>Download the <a href="https://svn.einsteintoolkit.org/cactus/EinsteinExamples/thornlists/einsteintoolkit.th">thornlist</a> for the Einstein Toolkit:</p>
-
-<p><tt>wget https://svn.einsteintoolkit.org/manifest/einsteintoolkit.th</tt></p>
-
-<h4>Download, Configure, and Build</h4>
-
-<p>Checkout the Einstein Toolkit using anonymous authentication:</p>
-
-<p><tt>./GetComponents -a einsteintoolkit.th</tt></p>
-<p>(This may take a few minutes.)</p>
-
-<p>This checks out Cactus, the Einstein Toolkit thorns, the Simulation Factory and example parameter
- files into a directory named Cactus.</p>
-
-
-<p>Configure the Simulation Factory</p>
-
-<p><tt>cd Cactus</tt><br>
-<tt>cp simfactory/udb.example.pm simfactory/udb.pm</tt>
-<br><tt>vi simfactory/udb.pm</tt></p>
-<p>Edit udb.pm and </p>
<ul>
-<li>replace YOUR_LOGIN with your username on Queen Bee
-<li>YOUR at EMAIL.ADDRESS with your usual email address
-<li>YOUR_ALLOCATION with your project allocation on Queen Bee
-</ul> </p>
-<!--<p>NOTE: At the moment you also need to change the line in mdb.pm with
- sourcebasedir for Queen Bee from <tt>/project/@USER@</tt>
- to <tt>/home/@USER@</tt> unless you have a directory in the
- /project space. We are working on improving this. </p>-->
+<li> <a href="experts.php">Information for Cactus experts</a>
+<li> <a href="tutorial.php">Tutorial for beginners</a>
+<li> <a href="list.php">List of relevant papers and reports</a>
-<p>Compile Executable</p>
+</ul>
-<p><tt>./simfactory/sim build --thornlist=../einsteintoolkit.th</tt></p>
-<p>(This may take a few minutes.)</p>
-<p>(You may receive an error message that building the utilities
- failed. This is fine as long as the main executable has been built
- correctly. You can check this with the command <tt>ls exe</tt>; if
- this shows a file <tt>cactus_sim</tt>, then you are fine.)</p>
-
-<h4>Run a Simulation</h4>
-
-<p>From the Einstein Toolkit directory, create a batch queue script and submit it to queue an example simulation:</p>
-
-<p><tt>./simfactory/sim create-submit static_tov --parfile=par/static_tov.par --procs=32 --walltime=8:0:0</tt></p>
-
-<p>To check the status of the simulation, use</p>
-
-<p><tt>./simfactory/sim list-simulations</tt></p>
-
-<h4>Look at Results</h4>
-
-<p>When the simulation is complete, move to the output directory (<tt>XXXX</tt>). You should see output files with the extension XXXX. These are 1D plots of the different grid variables. These can be plotted using e.g. gnuplot. An example plot of the XXXX is shown below.</p>
-
-<h4>Any Problems?</h4>
-
-This example should work smoothly on the TeraGrid machines Queen Bee, Ranger, Kraken and Abe. If you have any problems, please send details to <a href="mailto:users at einsteintoolkit.org">users at einsteintoolkit.org</a></tt>.</p>
-
<?php include_once($_SERVER['DOCUMENT_ROOT'].'/global/footer.php');?>
File [added]: list.php
Delta lines: +15 -0
===================================================================
--- info/documentation/list.php (rev 0)
+++ info/documentation/list.php 2010-04-11 19:01:45 UTC (rev 146)
@@ -0,0 +1,15 @@
+<?php $title='Documentation List';
+include_once($_SERVER['DOCUMENT_ROOT'].'/global/header.php');?>
+
+<p>
+<ul>
+
+<li> <b>Hydro interface:</b> Published conference paper (for CactusEinstein).
+
+<p>
+Erik Schnetter. Multi-physics coupling of Einstein and hydrodynamics evolution: A case study of the Einstein Toolkit. CBHPC 2008 (Component-Based High Performance Computing), 2008. (<a href="http://www.cct.lsu.edu/~eschnett/doc/Karlsruhe-2008-CBHPC-EinsteinToolkit.pdf">PDF</a>, 9 pages)</p>
+
+</ul>
+</p>
+
+<?php include_once($_SERVER['DOCUMENT_ROOT'].'/global/footer.php');?>
Property changes on: info/documentation/list.php
___________________________________________________________________
Name: svn:executable
+ *
File [added]: tutorial.php
Delta lines: +83 -0
===================================================================
--- info/documentation/tutorial.php (rev 0)
+++ info/documentation/tutorial.php 2010-04-11 19:01:45 UTC (rev 146)
@@ -0,0 +1,83 @@
+<?php $title='Beginners Tutorial';
+include_once($_SERVER['DOCUMENT_ROOT'].'/global/header.php');?>
+
+<p>This section provides a simple guide for compiling and running an example parameter file for the Einstein Toolkit.</p>
+
+<p>One complexity of high performance computing is the heterogeneous environments presented by different resources with different core software installations and local setups. For example, Einstein Toolkit codes necessitate compiling with MPI and then running the resulting application in a batch queue. As much as possible of this complexity is hidden in Cactus and accompanying tools such as the Simulation Factory.</p>
+
+<p>This worked example assumes that you are using the NSF TeraGrid resource <a href="http://www.loni.org/systems/system.php?system=QueenBee">Queen Bee</a>. If you don't have an existing account on Queen Bee you can <a href="request.php">request an account</a> to use for these examples.</p>
+
+<h4>Prepare some Tools</h4>
+
+<p>On Queen Bee (qb.loni.org), the <tt>git</tt> client will not be in your path by default. To add this type</p>
+<p><tt>soft add +git</tt></p>
+
+<p>Download the <a href="http://cactuscode.org/download/GetComponents">GetComponents</a> script which will checkout all the components of the Einstein Toolkit and ensure it is executable:</p>
+
+<p><tt>wget http://cactuscode.org/download/GetComponents</tt>
+<br>
+<tt>chmod 755 GetComponents</tt></p>
+
+
+<p>Download the <a href="https://svn.einsteintoolkit.org/cactus/EinsteinExamples/thornlists/einsteintoolkit.th">thornlist</a> for the Einstein Toolkit:</p>
+
+<p><tt>wget https://svn.einsteintoolkit.org/manifest/einsteintoolkit.th</tt></p>
+
+<h4>Download, Configure, and Build</h4>
+
+<p>Checkout the Einstein Toolkit using anonymous authentication:</p>
+
+<p><tt>./GetComponents -a einsteintoolkit.th</tt></p>
+<p>(This may take a few minutes.)</p>
+
+<p>This checks out Cactus, the Einstein Toolkit thorns, the Simulation Factory and example parameter
+ files into a directory named Cactus.</p>
+
+
+<p>Configure the Simulation Factory</p>
+
+<p><tt>cd Cactus</tt><br>
+<tt>cp simfactory/udb.example.pm simfactory/udb.pm</tt>
+<br><tt>vi simfactory/udb.pm</tt></p>
+<p>Edit udb.pm and </p>
+<ul>
+<li>replace YOUR_LOGIN with your username on Queen Bee
+<li>YOUR at EMAIL.ADDRESS with your usual email address
+<li>YOUR_ALLOCATION with your project allocation on Queen Bee
+</ul> </p>
+
+<!--<p>NOTE: At the moment you also need to change the line in mdb.pm with
+ sourcebasedir for Queen Bee from <tt>/project/@USER@</tt>
+ to <tt>/home/@USER@</tt> unless you have a directory in the
+ /project space. We are working on improving this. </p>-->
+
+<p>Compile Executable</p>
+
+<p><tt>./simfactory/sim build --thornlist=../einsteintoolkit.th</tt></p>
+
+<p>(This may take a few minutes.)</p>
+
+<p>(You may receive an error message that building the utilities
+ failed. This is fine as long as the main executable has been built
+ correctly. You can check this with the command <tt>ls exe</tt>; if
+ this shows a file <tt>cactus_sim</tt>, then you are fine.)</p>
+
+<h4>Run a Simulation</h4>
+
+<p>From the Einstein Toolkit directory, create a batch queue script and submit it to queue an example simulation:</p>
+
+<p><tt>./simfactory/sim create-submit static_tov --parfile=par/static_tov.par --procs=32 --walltime=8:0:0</tt></p>
+
+<p>To check the status of the simulation, use</p>
+
+<p><tt>./simfactory/sim list-simulations</tt></p>
+
+<h4>Look at Results</h4>
+
+<p>When the simulation is complete, move to the output directory (<tt>XXXX</tt>). You should see output files with the extension XXXX. These are 1D plots of the different grid variables. These can be plotted using e.g. gnuplot. An example plot of the XXXX is shown below.</p>
+
+<h4>Any Problems?</h4>
+
+This example should work smoothly on the TeraGrid machines Queen Bee, Ranger, Kraken and Abe. If you have any problems, please send details to <a href="mailto:users at einsteintoolkit.org">users at einsteintoolkit.org</a></tt>.</p>
+
+<?php include_once($_SERVER['DOCUMENT_ROOT'].'/global/footer.php');?>
Property changes on: info/documentation/tutorial.php
___________________________________________________________________
Name: svn:executable
+ *
More information about the Commits
mailing list