Setup Tutorial - Revision history

Rhaas at 13:12, 16 April 2024

2024-04-16T13:12:15Z

Sbrandt at 15:08, 20 October 2017

2017-10-20T15:08:00Z

Sbrandt at 12:17, 13 October 2017

2017-10-13T12:17:02Z

Sbrandt at 12:13, 13 October 2017

2017-10-13T12:13:02Z

141.142.42.12: /* Laptop/workstation operating systems */

2017-09-04T22:41:28Z

‎Laptop/workstation operating systems

141.142.42.12: /* Prerequisites */

2017-09-04T22:33:40Z

‎Prerequisites

141.142.42.12: /* Prerequisites */

2017-09-04T22:33:12Z

‎Prerequisites

Rhaas: /* Laptop/workstation operating systems */

2017-09-04T22:17:16Z

‎Laptop/workstation operating systems

Rhaas: /* Prerequisites */

2017-09-04T22:16:56Z

‎Prerequisites

Rhaas: /* Prerequisites */

2017-09-04T22:16:12Z

‎Prerequisites

←Older revision		Revision as of 13:12, 16 April 2024
Line 1:		Line 1:
		+	<div style="border: 2px solid black; padding: 4px">
		+	[[File:warning.png\|24px]]
		+	<span style="color:red">'''This tutorial is obsolete.'''</span>
		+	Please use: the [http://einsteintoolkit.org/documentation/new-user-tutorial jupyter based one instead]
		+	</div>
		+
	=Introduction=		=Introduction=
	<onlyinclude>		<onlyinclude>

@@ Line 75: / Line 75: @@
 ===Laptop/workstation operating systems===
-SimFactory contains general support for specific operating systems commonly used on workstations or laptops. Currently this list includes Linux/Ubuntu, Linux/Debian, Linux/Fedora, MacOS/Homebrew, MacOS/MacPorts, Windows10/BashTerminal.  <!--The following table lists the supported operating systems, and the information needed to configure SimFactory on each one.
+SimFactory contains general support for specific operating systems commonly used on workstations or laptops. Currently this list includes Linux/Ubuntu, Linux/Debian, Linux/Fedora, MacOS/Homebrew, MacOS/MacPorts, Windows10/BashTerminal.  The following table lists the supported operating systems, and the information needed to configure SimFactory on each one.
 {| class="wikitable" style="border: 1pt solid black;"

@@ Line 116: / Line 116: @@
 Once all required packages have been installed, run
-     simfactory/bin/sim setup-silent yyy
+     simfactory/bin/sim setup-silent
 After this step is complete you will find your machine's default setup under
@@ Line 146: / Line 122: @@
 You can edit some of these settings freely, such as "description", "basedir" etc. Some entry edits could result in simulation start-up warnings and/or errors such as "ppn" (processor-per-node meaning number of cores on your machine), "num-threads" (number of threads per core) so such edits must be done with some care.
 ==Building the Einstein Toolkit==
@@ Line 186: / Line 127: @@
 Assuming that SimFactory has been successfully set up on your machine, you should be able to build the Einstein Toolkit with
-     simfactory/bin/sim build --mdbkey make 'make -j2' --thornlist manifest/einsteintoolkit.th
+     simfactory/bin/sim build -j2 --thornlist manifest/einsteintoolkit.th
 Adjust -j2 to match the number of cores your machine possesses if you want to use more or less than 2 parallel build processes. This may take a while, as it compiles all the thorns specified in manifest/einsteintoolkit.th.
@@ Line 195: / Line 136: @@
 You can now run the Einstein Toolkit with a simple test parameter file.
-     simfactory/bin/sim submit helloworld --parfile arrangements/CactusExamples/HelloWorld/par/HelloWorld.par --walltime 0:5:0
+     simfactory/bin/sim create-submit helloworld --parfile arrangements/CactusExamples/HelloWorld/par/HelloWorld.par --walltime 0:5:0
 This will submit the simulation to the queue naming it "helloworld" and ask for a 5 minutes long job time, if you are running on a cluster, or run it immediately in the background if you are on a personal laptop or workstation.  You can check the status of the simulation with

@@ Line 116: / Line 116: @@
 Once all required packages have been installed, run
-     simfactory/bin/sim setup-silent --optionlist=<optionlist> --runscript <runscript>
+     simfactory/bin/sim setup-silent yyy
 where <optionlist> and <runscript> are taken from the table above.  This will create a new "machine definition" for your machine, named after your machine hostname, in simfactory/mdb/machines/<hostname>.ini, as well as write user-specific settings to simfactory/etc/defs.local.ini.

@@ Line 145: / Line 145: @@
 ./simfactory/mdb/machines/<hostname >.ini
-You can edit some of these settings freely, such as "description", "basedir" etc. Some entry edits could result in simulation start-up warnings and/or errors such as "ppn" (processor-per-node meaning number of cores per cpu), "num-threads" (number of threads per core), "nodes" (number of cpus) so such edits must be done with some care.
+You can edit some of these settings freely, such as "description", "basedir" etc. Some entry edits could result in simulation start-up warnings and/or errors such as "ppn" (processor-per-node meaning number of cores on your machine), "num-threads" (number of threads per core) so such edits must be done with some care.
 ===Compute clusters===

@@ Line 16: / Line 16: @@
   # Ubuntu (16.04.2, 17.04)
   sudo apt-get install build-essential mpich2? python libmpich2?-dev gfortran git subversion curl gnuplot gnuplot-x11
-  # Fedora (FC 26)
+  # Fedora (FC 25, 26)
   sudo yum -y install mpich2 python mpich2-devel gsl gsl-devel libjpeg-devel hdf5 hdf5-mpich-devel gcc gcc-c++ gcc-gfortran patch numactl-devel numactl hwloc subversion git openssl-devel lapack-static

@@ Line 139: / Line 139: @@
   ./simfactory/bin/sim setup-silent --optionlist=osx-homebrew.cfg --runscript generic-mpi.run
-  # Windows10+BashTerminal
+  # Windows10+LinuxSubsystem
   ./simfactory/bin/sim setup-silent --optionlist=ubuntu.cfg --runscript debian.sh
@@ Line 146: / Line 146: @@
 You can edit some of these settings freely, such as "description", "basedir" etc. Some entry edits could result in simulation start-up warnings and/or errors such as "ppn" (processor-per-node meaning number of cores per cpu), "num-threads" (number of threads per core), "nodes" (number of cpus) so such edits must be done with some care.
 ===Compute clusters===

@@ Line 28: / Line 28: @@
   # Windows10+LinuxSubsystem (Anniversary Update)
-  # Make sure to [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide Linux Subsystem] and you are effectively
+  # Make sure to install the [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide Linux Subsystem] and you are effectively
   # running a Ubuntu Linux systems but have to install a separate X11 server as
   # well as making sure that the system can resolve its own hostname

@@ Line 19: / Line 19: @@
   su -c ' yum -y install mpich2 python mpich2-devel gsl gsl-devel libjpeg-devel hdf5 hdf5-mpich-devel gcc gcc-c++ gcc-gfortran patch numactl-devel numactl hwloc subversion git openssl-devel lapack-static'
-  # If you have MacOS and use [https://www.macports.org/install.php MacPorts], and use the following commands
+  # MacOS+MacPorts (Yosemite)
- # (last tested for Yosemite):
+ # Install [https://www.macports.org/install.php MacPorts] first, then do
   sudo port install subversion git gnuplot szip jpeg gcc46 fftw fftw-3 gsl openssl hdf5 +fortran +gcc46 -universal zlib openmpi +gcc46
-  # If you have MacOS and use [https://brew.sh/ Homebrew], and use the
+  # MacOS+Homebrew (Sierra)
- # following commands (last tested for Sierra):
+ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   brew tap homebrew/science
   brew install subversion gnuplot subversion gcc fftw gsl hdf5 --with-fortran hwloc jpeg openssl pkg-config szip open-mpi
-  # If you have Windows 10 and use the [https://msdn.microsoft.com/en-us/commandline/wsl/install_guide Linux Subsystem] you are effectively
+  # Windows10+LinuxSubsystem (Anniversary Update)
   # running a Ubuntu Linux systems but have to install a separate X11 server as
   # well as making sure that the system can resolve its own hostname