cfcfd3: doc/sphinx/getting-started.rst annotate

annotate doc/sphinx/getting-started.rst @ 1006:988c8fb85d4a

Maintenance of the Eilmer3 documentation. (1) Refresh the PDF User Guide for Eilmer3. The one on the web site was several months old. (2) Added notes on putting the external code CEA and NIST in the right place. (3) A refresh of the group member list. (4) Updated the build lut description in the Eilmer3 user guide (Rowan's request). (5) Added higher-resolution results to Hakkinen example. (6) Added descriptions for quadrilateral patches.

author	Peter Jacobs <peterj@mech.uq.edu.au>
date	Mon, 10 Jun 2013 10:26:53 +0100
parents	21f3c3f22703
children	9d009d259f5e

rev	line source
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	1 Getting the codes and preparing to run them
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	2 ===========================================
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	3
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	4 The code repository
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	5 -------------------
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	6 The codes are available for download from a Mercurial repository.
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	7 To make a clone of the repository::
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	8
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	9 $ cd $HOME
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	10 $ hg clone https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/ cfcfd3
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	11
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	12 This takes about 40 seconds on campus at UQ.
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	13 It may take much longer, depending on your internet connection.
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	14
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	15 To see what's changed::
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	16
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	17 $ cd cfcfd3
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	18 $ hg incoming https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	19 ...
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	20 $ hg pull -u https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	21
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	22 Notes
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	23
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	24 #. You will need a password for any access. Please ask.
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	25 #. You can read but not write with the "cfcfdlocal" username.
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	26 #. Some usernames (by negotiation) may push changesets back to the repository.
1006 988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	27 #. Some gas models depend on the NASA CEA code or the NIST REFPROP library.
988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	28 If you want to use these models (and there is no look-up-table equivalent
988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	29 already available) you will need to obtain these codes and place them
988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	30 into the extern/ directory.
988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	31 They are not included as part of our cfcfd3 repository but the cfcfd3 makefiles
988c8fb85d4a Maintenance of the Eilmer3 documentation. Peter Jacobs <peterj@mech.uq.edu.au> parents: 895 diff changeset	32 will be aware of them if they are sitting in the extern/ directory.
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	33
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	34
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	35 Licence
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	36 -------
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	37 CFCFD program collection is a set of flow simulation tools for compressible fluids.
170 85355f691bf1 sphinx docs: some re-shuffling of Fedora notes. Peter Blyton <p.blyton@uq.edu.au> parents: 168 diff changeset	38 Copyright (C) 1991-2012 Peter Jacobs, Rowan Gollan, Daniel Potter,
85355f691bf1 sphinx docs: some re-shuffling of Fedora notes. Peter Blyton <p.blyton@uq.edu.au> parents: 168 diff changeset	39 Brendan O'Flaherty, Fabian Zander, Wilson Chan, Peter Blyton and
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	40 other members of the CFCFD group.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	41
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	42 This collection is free software: you can redistribute it and/or modify
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	43 it under the terms of the GNU General Public License as published by
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	44 the Free Software Foundation, either version 3 of the License, or any later version.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	45
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	46 This program collection is distributed in the hope that it will be useful,
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	47 but WITHOUT ANY WARRANTY; without even the implied warranty of
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	48 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	49 See the GNU General Public License for more details.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	50
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	51 You should have received a copy of the GNU-General-Public-License_
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	52 along with this program. If not, see <http://www.gnu.org/licenses/>.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	53
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	54 .. _GNU-General-Public-License: ./_static/gpl.txt
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	55
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	56
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	57 Your computational environment
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	58 ------------------------------
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	59 The code collection comes as source code only so,
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	60 to use any of them, you will need to compile and install them.
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	61
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	62 To build and run the newer codes, you will need the following:
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	63
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	64 * a Unix-like system with GNU-make, C and C++ compilers
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	65 * popt (command-line parser) library and development files
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	66 * readline library (including the header files, libreadline-dev on Ubuntu)
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	67 * Python + the numpy, matplotlib and scipy extensions
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	68 * SWIG
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	69 * Tcl/Tk + the BWidget library (to run the GUI program e3console.tcl)
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	70
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	71 We have been able to get the programs to build on Linux, MacOS-X
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	72 (with a recent Xcode development environment) and Cygwin 1.7 (on MS-Windows).
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	73
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	74 On MS-Windows, install the full kit of Cygwin (Python, X-Windows and all)
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	75 and be careful not to have another Python installed outside of Cygwin.
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	76 The multiple installations of Python seem not to play well together.
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	77
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	78 Some other things that are useful:
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	79
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	80 * awk
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	81 * MetaPost (mpost) or, more recently, InkScape (for looking at and editing svg files)
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	82 * GNUplot
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	83 * Paraview or MayaVi or VisIt
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	84
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	85 To a basic Fedora 16 installation, you should add the following packages:
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	86
51 d78d998b7c1f First pass at resurrecting the doxygen documentation. Peter Blyton <p.blyton@uq.edu.au> parents: 33 diff changeset	87 #. mercurial
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	88 #. gcc
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	89 #. gcc-c++
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	90 #. m4
170 85355f691bf1 sphinx docs: some re-shuffling of Fedora notes. Peter Blyton <p.blyton@uq.edu.au> parents: 168 diff changeset	91 #. openmpi
85355f691bf1 sphinx docs: some re-shuffling of Fedora notes. Peter Blyton <p.blyton@uq.edu.au> parents: 168 diff changeset	92 #. openmpi-devel (to use openmpi on Fedora, :ref:`the module must be loaded <label-openmpi-fedora>`)
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	93 #. gcc-gfortran
368 a4edafcbff20 doc: Added note about need to install libgcc.i686 on Fedora-type systems for CEA2 compile. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 289 diff changeset	94 #. libgfortran.i686, glibc-devel.i686 and libgcc.i686 (to compile the 32-bit CEA code on 64-bit Fedora)
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	95 #. swig
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	96 #. python-devel
33 9aefbfafb6d1 Sphinx docs: Added air-Mach-12.3 example to poshax3 documentation. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 29 diff changeset	97 #. numpy
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	98 #. python-matplotlib
33 9aefbfafb6d1 Sphinx docs: Added air-Mach-12.3 example to poshax3 documentation. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 29 diff changeset	99 #. scipy
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	100 #. readline-devel (for Lua)
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	101 #. popt-devel
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	102
172 a858acad05c5 Sphinx docs: A couple of extra comments on installing to a Debian system. Peter Jacobs <peterj@mech.uq.edu.au> parents: 170 diff changeset	103 To a basic Ubuntu 10.04 (or any recent Debian derivative) installation,
a858acad05c5 Sphinx docs: A couple of extra comments on installing to a Debian system. Peter Jacobs <peterj@mech.uq.edu.au> parents: 170 diff changeset	104 you should add the following packages and their dependencies:
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	105
51 d78d998b7c1f First pass at resurrecting the doxygen documentation. Peter Blyton <p.blyton@uq.edu.au> parents: 33 diff changeset	106 #. mercurial
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	107 #. g++
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	108 #. m4
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	109 #. mpi-default-dev
147 ae30202acc15 Small edits to docs, as suggested by Fabs. Peter Jacobs <peterj@mech.uq.edu.au> parents: 142 diff changeset	110 #. mpi-default-bin
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	111 #. gfortran
172 a858acad05c5 Sphinx docs: A couple of extra comments on installing to a Debian system. Peter Jacobs <peterj@mech.uq.edu.au> parents: 170 diff changeset	112 #. gfortran-multilib (for compiling 32-bit CEA2 on a 64-bit system)
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	113 #. swig
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	114 #. python-dev
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	115 #. python-numpy
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	116 #. python-matplotlib
24 35bd8af5f52a Sphinx doc changes to fill out L1d3 intro. Also, add scipy to dependency list. Peter Jacobs <peterj@mech.uq.edu.au> parents: 17 diff changeset	117 #. python-scipy
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	118 #. libreadline-dev
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	119 #. libpopt-dev
376 3c16b6aa523d doc/sphinx: corrected ubuntu package name for libncurses5-dev. Elise Fahy <e.fahy@uq.edu.au> parents: 368 diff changeset	120 #. libncurses5-dev
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	121 #. tk
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	122 #. bwidget
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	123 #. gnuplot
142 62e974ac1e4d Eilmer3 user guide and sphinx docs: moved cluster computer notes to sphinx. Peter Jacobs <peterj@mech.uq.edu.au> parents: 115 diff changeset	124 #. tcl-dev (if you want to build IMOC)
62e974ac1e4d Eilmer3 user guide and sphinx docs: moved cluster computer notes to sphinx. Peter Jacobs <peterj@mech.uq.edu.au> parents: 115 diff changeset	125 #. maxima (to run the Method-of-Manufactured-Solutions test case for Eilmer3)
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	126
895 21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	127 Compiler versions
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	128 -----------------
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	129 Since March 2013, we have started using some of the C++11 features
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	130 such as range-based for loops and initializer expressions.
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	131 Because of this you will need a suitable C++ compiler.
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	132 For the GNU compiler collection, versions 4.6.3 and 4.8.0 are suitable.
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	133 Clang/LLVM versions 3.2 and later are also good.
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme. Peter Jacobs <peterj@mech.uq.edu.au> parents: 376 diff changeset	134
29 2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	135 Using the codes on MS-Windows
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	136 -----------------------------
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	137 The codes assemble most conveniently on a Linux/Unix-like environment.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	138 They should also build and run within Cygwin (http://cygwin.com/), however,
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	139 it may be convenient to run a full linux installation within
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	140 VirtualBox (https://www.virtualbox.org/), on your MS-Windows computer.
2e97ce715ec0 Make the tacit licence explicit. Peter Jacobs <peterj@mech.uq.edu.au> parents: 24 diff changeset	141
115 daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	142 Using the codes on Apple OSX
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	143 ----------------------------
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	144 The codes can be compiled and run on OSX as this is a Unix based OS.
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	145 The Xcode development environment (https://developer.apple.com/xcode/)
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	146 should be downloaded and installed to provide Apple's versions of the
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	147 GNU Compiler Collection, Python and the make utility, amongst other
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	148 development tools.
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	149 popt, readline, SWIG and Tcl/Tk can either be installed from source
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	150 or via a package manager such as MacPorts (http://www.macports.org/) or
daa947d96290 Brief OSX documentation, and some additional constants and unit Daniel Potter (laptop) <d.potter@uq.edu.au> parents: 51 diff changeset	151 Fink (http://www.finkproject.org/).
238 f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	152
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	153 Notes:
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	154
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	155 #. If possible, it is recommended to install these dependencies from source.
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	156 #. The required Python packages (numpy, scipy and matplotlib) are all available
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	157 as pre-packaged binaries for OSX on sourceforge.net, although they can also
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	158 be installed from source if necessary.
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	159 #. Ingo has had a good experience installing binary packages from MacPorts,
f616b4f4475b Make targets added, specific for Ingo's Mac OS X. Peter Jacobs <peterj@mech.uq.edu.au> parents: 222 diff changeset	160 the only subtly being the need to install swig and swig-python.
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	161
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	162 SSH access to the repository for developers
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	163 -------------------------------------------
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	164 Alternative access to the Mercurial repository for developers is possible via ssh.
a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	165 You will need the password or your public key installed for any access. Please ask.
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	166
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	167 ::
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	168
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	169 $ cd ~
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	170 $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	171 $ cd cfcfd3/extern/
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	172 $ hg clone ssh://cfcfd3@triton/cea2-hg cea2
222 9a17acd9c121 sphinx docs: added notes about setting up the REFPROP gas model. Peter Blyton <p.blyton@uq.edu.au> parents: 172 diff changeset	173 $ hg clone ssh://geothermal@triton/refprop-hg refprop
8 663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	174
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages. Peter Jacobs <peterj@mech.uq.edu.au> parents: diff changeset	175
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	176
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	177 Notes about Mercurial and https certificate warnings
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	178 ----------------------------------------------------
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	179 For versions of Mercurial greater than 1.7.3, a warning will be issued
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	180 about the certificate not being verified when accessing the repository
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	181 over https. To satisy Mercurial's complaints, you will need to configure
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	182 the Certificate Authorities (CAs) which it uses. There are two ways to
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	183 do this:
16 a587197c464d Sphinx docs: Have the top-level files pretty much in order. Peter Jacobs <peterj@mech.uq.edu.au> parents: 8 diff changeset	184
17 a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	185 1. configure HTTPS certificate authorities; or
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	186 2. verify ``triton.pselab.uq.edu.au`` individually using its fingerprint.
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	187
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	188 In either case, you will need to edit your hg configuration file which
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	189 can be a repository-specific file ``.hg/hgrc`` or set globally in
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	190 ``~/.hgrc``.
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	191
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	192 To configure the certificate authorities, the value for ``cacerts`` need to
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	193 be set correctly for your system. For example, a Fedora (or Fedora-like) linux system,
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	194 this can be done by adding the following to the ``hgrc`` file::
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	195
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	196 [web]
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	197 cacerts = /etc/ssl/certs/ca-bundle.crt
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	198
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	199 Examples for other linux systems can be found at MercurialCAs_.
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	200
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	201 The alternative is to configure the host fingerprint for
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	202 ``triton.pselab.uq.edu.au`` explicitly. To do this, add
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	203 the following to your hg config file::
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	204
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	205 [hostfingerprints]
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	206 triton.pselab.uq.edu.au = 1d:33:32:b0:6c:e2:5c:13:67:35:ba:e6:60:cc:4e:c1:03:63:5a:2e
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	207
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	208 More information about configuring Mercurial to use your system's certificate
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	209 authorities is available at MercurialCAs_.
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	210
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	211
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https. Rowan J. Gollan <r.gollan@uq.edu.au> parents: 16 diff changeset	212 .. _MercurialCAs: http://mercurial.selenic.com/wiki/CACertificates

Mercurial > hg > cfcfd3

annotate doc/sphinx/getting-started.rst @ 1006:988c8fb85d4a