Mercurial > hg > cfcfd3

annotate doc/sphinx/getting-started.rst @ 2606:75cd6e570d11 default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update the web server update script to go to the new gdtk server.
author Peter Jacobs <peterj@mech.uq.edu.au>
date Wed, 20 Jul 2022 08:58:55 +1000
parents d43f84d76642
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 -------------------
2417
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
6 The codes are available for download from a public 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
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
10 $ hg clone https://source.eait.uq.edu.au/hg/cfcfd3 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
2417
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
12 You may provide the username "cfcfd-user@svn.itee.uq.edu.au" for authentication but
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
13 no password is required for reading.
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
14 Cloning the repository takes about 40 seconds on campus at UQ.
16
a587197c464d Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 8
diff changeset
15 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
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 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
18
17
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
19 $ cd cfcfd3
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
20 $ hg incoming https://source.eait.uq.edu.au/hg/cfcfd3
17
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
21 ...
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
22 $ hg pull -u https://source.eait.uq.edu.au/hg/cfcfd3
8
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 Notes
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
25
2417
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
26 #. You do not need a password for for read access.
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
27 #. You can read but not write with the "cfcfd-user" username.
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
28 #. Some usernames (cfcfd-dev@svn.itee.uq.edu.au) may push changesets back
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
29 to the repository. You will need to negotiate a developer role for this access.
1006
988c8fb85d4a Maintenance of the Eilmer3 documentation.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 895
diff changeset
30 #. 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
31 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
32 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
33 into the extern/ directory.
988c8fb85d4a Maintenance of the Eilmer3 documentation.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 895
diff changeset
34 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
35 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
36
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
37
29
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
38 Licence
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
39 -------
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
40 CFCFD program collection is a set of flow simulation tools for compressible fluids.
2513
dee86da87fdd Added sphinx pages for Eilmer4.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 2417
diff changeset
41 Copyright (C) 1991-2017 Peter Jacobs, Rowan Gollan, Daniel Potter,
2417
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
42 Ingo Jahn, Anand Veeraragavan, Vince Wheatley, Daryl Bond, Chris James
c2daa7b406e3 Small adjustments for the web pages, now that the repo is public.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1740
diff changeset
43 and other members of the CFCFD group.
29
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
44
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
45 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
46 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
47 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
48
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
49 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
50 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
51 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
52 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
53
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
54 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
55 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
56
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
57 .. _GNU-General-Public-License: ./_static/gpl.txt
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
58
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
59
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
60 Your computational environment
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 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
63 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
64
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
65 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
66
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
67 * 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
68 * 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
69 * 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
70 * 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
71 * SWIG
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
72 * 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
73
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
74 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
75 (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
76
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
77 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
78 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
79 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
80
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
81 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
82
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
83 * awk
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
84 * 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
85 * GNUplot
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
86 * 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
87
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
88 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
89
51
d78d998b7c1f First pass at resurrecting the doxygen documentation.
Peter Blyton <p.blyton@uq.edu.au>
parents: 33
diff changeset
90 #. mercurial
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
91 #. gcc
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
92 #. gcc-c++
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
93 #. m4
170
85355f691bf1 sphinx docs: some re-shuffling of Fedora notes.
Peter Blyton <p.blyton@uq.edu.au>
parents: 168
diff changeset
94 #. openmpi
1604
9d009d259f5e Clean up cone20-simple example for the user guide and reconnect symbolic links
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1006
diff changeset
95 #. openmpi-devel
9d009d259f5e Clean up cone20-simple example for the user guide and reconnect symbolic links
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1006
diff changeset
96 (to use openmpi on Fedora,
9d009d259f5e Clean up cone20-simple example for the user guide and reconnect symbolic links
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1006
diff changeset
97 :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
98 #. gcc-gfortran
1604
9d009d259f5e Clean up cone20-simple example for the user guide and reconnect symbolic links
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1006
diff changeset
99 #. libgfortran.i686, glibc-devel.i686 and libgcc.i686
9d009d259f5e Clean up cone20-simple example for the user guide and reconnect symbolic links
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1006
diff changeset
100 (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
101 #. swig
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
102 #. 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
103 #. numpy
29
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
104 #. 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
105 #. scipy
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
106 #. 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
107 #. popt-devel
1632
d7dc0216b139 doc/sphinx: Replaced note about maxima dependency with sympy.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 1604
diff changeset
108 #. sympy (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
109
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
110 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
111 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
112
51
d78d998b7c1f First pass at resurrecting the doxygen documentation.
Peter Blyton <p.blyton@uq.edu.au>
parents: 33
diff changeset
113 #. mercurial
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
114 #. g++
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
115 #. m4
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
116 #. mpi-default-dev
147
ae30202acc15 Small edits to docs, as suggested by Fabs.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 142
diff changeset
117 #. 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
118 #. 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
119 #. 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
120 #. swig
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
121 #. python-dev
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
122 #. python-numpy
29
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
123 #. 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
124 #. python-scipy
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
125 #. libreadline-dev
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
126 #. libpopt-dev
376
3c16b6aa523d doc/sphinx: corrected ubuntu package name for libncurses5-dev.
Elise Fahy <e.fahy@uq.edu.au>
parents: 368
diff changeset
127 #. libncurses5-dev
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
128 #. tk
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
129 #. bwidget
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
130 #. 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
131 #. tcl-dev (if you want to build IMOC)
1632
d7dc0216b139 doc/sphinx: Replaced note about maxima dependency with sympy.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 1604
diff changeset
132 #. python-sympy (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
133
895
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 376
diff changeset
134 Compiler versions
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 376
diff changeset
135 -----------------
21f3c3f22703 Eilmer3 documentation: selection of stepping scheme.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 376
diff changeset
136 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
137 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
138 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
139 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
140 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
141
29
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
142 Using the codes on MS-Windows
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
143 -----------------------------
2e97ce715ec0 Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 24
diff changeset
144 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
145 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
146 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
147 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
148
115
daa947d96290 Brief OSX documentation, and some additional constants and unit
Daniel Potter (laptop) <d.potter@uq.edu.au>
parents: 51
diff changeset
149 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
150 ----------------------------
daa947d96290 Brief OSX documentation, and some additional constants and unit
Daniel Potter (laptop) <d.potter@uq.edu.au>
parents: 51
diff changeset
151 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
152 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
153 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
154 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
155 development tools.
daa947d96290 Brief OSX documentation, and some additional constants and unit
Daniel Potter (laptop) <d.potter@uq.edu.au>
parents: 51
diff changeset
156 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
157 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
158 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
159
f616b4f4475b Make targets added, specific for Ingo's Mac OS X.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 222
diff changeset
160 Notes:
f616b4f4475b Make targets added, specific for Ingo's Mac OS X.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 222
diff changeset
161
f616b4f4475b Make targets added, specific for Ingo's Mac OS X.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 222
diff changeset
162 #. 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
163 #. 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
164 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
165 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
166 #. 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
167 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
168
16
a587197c464d Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 8
diff changeset
169 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
170 -------------------------------------------
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
171 Alternative access to the Mercurial repository for developers is possible via https.
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
172 You will need the password for the cfcfd-dev@svn.itee.uq.edu.au login. Please ask.
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
173
17
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
174 ::
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
175
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
176 $ cd ~
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
177 $ hg clone https://source.eait.uq.edu.au/hg/cfcfd3 cfcfd3
17
a54503138206 Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents: 16
diff changeset
178 $ cd cfcfd3/extern/
1740
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
179 $ hg clone https://source.eait.uq.edu.au/hg/cea2 cea2
102e61645069 Updated web-page notes to point to the new EAIT-hosted repository.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 1632
diff changeset
180 $ hg clone https://source.eait.uq.edu.au/hg/refprop refprop
8
663bc627945e Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff changeset
181
16
a587197c464d Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents: 8
diff changeset
182