Mercurial > hg > cfcfd3
annotate doc/sphinx/getting-started.rst @ 33:9aefbfafb6d1
Sphinx docs: Added air-Mach-12.3 example to poshax3 documentation.
In this commit, I have added a poshax3 subdirectory to the sphinx
source area. I added symlinks (ln -s TARGET LINKNAME) to the
sphinx/poshax3 directory which point to the real files in:
examples/poshax3/air-Mach-12.3.
I also fixed the package names for a Fedora 16 installation
as listed in getting-started.rst
author | Rowan J. Gollan <r.gollan@uq.edu.au> |
---|---|
date | Tue, 07 Feb 2012 23:02:34 +1000 |
parents | 2e97ce715ec0 |
children | d78d998b7c1f |
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. |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
27 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
28 |
29
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
29 Licence |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
30 ------- |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
31 CFCFD program collection is a set of flow simulation tools for compressible fluids. |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
32 Copyright (C) 1991-2012 Peter Jacobs, Rowan Gollan, Daniel Potter and |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
33 other members of the CFCFD group. |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
34 |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
35 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
|
36 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
|
37 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
|
38 |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
39 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
|
40 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
|
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
42 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
|
43 |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
44 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
|
45 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
|
46 |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
47 .. _GNU-General-Public-License: ./_static/gpl.txt |
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 |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
50 Your computational environment |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
51 ------------------------------ |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
52 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
|
53 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
|
54 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
55 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
|
56 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
57 * 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
|
58 * 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
|
59 * 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
|
60 * 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
|
61 * SWIG |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
62 * 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
|
63 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
64 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
|
65 (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
|
66 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
67 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
|
68 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
|
69 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
|
70 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
71 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
|
72 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
73 * awk |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
74 * 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
|
75 * GNUplot |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
76 * 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
|
77 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
78 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
|
79 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
80 #. bzr |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
81 #. gcc |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
82 #. gcc-c++ |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
83 #. m4 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
84 #. gcc-gfortran |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
85 #. swig |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
86 #. 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
|
87 #. numpy |
29
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
88 #. 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
|
89 #. scipy |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
90 #. 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
|
91 #. popt-devel |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
92 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
93 To a basic Ubuntu 10.04 installation, you should add the following packages and their dependencies: |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
94 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
95 #. bzr |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
96 #. bzrtools |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
97 #. g++ |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
98 #. m4 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
99 #. mpi-default-dev |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
100 #. gfortran |
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-dev |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
103 #. python-numpy |
29
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
104 #. 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
|
105 #. python-scipy |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
106 #. libreadline-dev |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
107 #. libpopt-dev |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
108 #. tk |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
109 #. bwidget |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
110 #. gnuplot |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
111 |
29
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
112 Using the codes on MS-Windows |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
113 ----------------------------- |
2e97ce715ec0
Make the tacit licence explicit.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
24
diff
changeset
|
114 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
|
115 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
|
116 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
|
117 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
|
118 |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
119 |
16
a587197c464d
Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
8
diff
changeset
|
120 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
|
121 ------------------------------------------- |
a587197c464d
Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
8
diff
changeset
|
122 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
|
123 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
|
124 |
17
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
125 :: |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
126 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
127 $ cd ~ |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
128 $ 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
|
129 $ 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
|
130 $ hg clone ssh://cfcfd3@triton/cea2-hg cea2 |
8
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
131 |
663bc627945e
Started sphinx documentation, to eventually replace the cfcfd web pages.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
diff
changeset
|
132 |
16
a587197c464d
Sphinx docs: Have the top-level files pretty much in order.
Peter Jacobs <peterj@mech.uq.edu.au>
parents:
8
diff
changeset
|
133 |
17
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
134 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
|
135 ---------------------------------------------------- |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
136 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
|
137 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
|
138 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
|
139 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
|
140 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
|
141 |
17
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
142 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
|
143 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
|
144 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
145 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
|
146 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
|
147 ``~/.hgrc``. |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
148 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
149 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
|
150 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
|
151 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
|
152 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
153 [web] |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
154 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
|
155 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
156 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
|
157 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
158 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
|
159 ``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
|
160 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
|
161 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
162 [hostfingerprints] |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
163 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
|
164 |
a54503138206
Sphinx docs: Added notes about suppressing certificate warnings over https.
Rowan J. Gollan <r.gollan@uq.edu.au>
parents:
16
diff
changeset
|
165 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
|
166 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
|
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 .. _MercurialCAs: http://mercurial.selenic.com/wiki/CACertificates |