Mercurial > hg > cfcfd3
diff doc/sphinx/getting-started.rst @ 16:a587197c464d
Sphinx docs: Have the top-level files pretty much in order.
Have rescued the Theses and Reports content from the old web pages
and found a new home for it in the new order of things.
The actual PDF files for theses are not in the repository but
are in my ~/papers/theses directory and get copied over to the
web server after the Sphinx build is done.
| author | Peter Jacobs <peterj@mech.uq.edu.au> |
|---|---|
| date | Tue, 31 Jan 2012 18:51:05 +1000 |
| parents | 663bc627945e |
| children | a54503138206 |
line wrap: on
line diff
--- a/doc/sphinx/getting-started.rst Mon Jan 30 12:22:46 2012 +0100 +++ b/doc/sphinx/getting-started.rst Tue Jan 31 18:51:05 2012 +1000 @@ -1,19 +1,29 @@ -Getting Started -=============== +Getting the codes and preparing to run them +=========================================== + +The code repository +------------------- +The codes are available for download from a Mercurial repository. +To make a clone of the repository: -Getting the current code collection ------------------------------------ -The codes are available for download via a Mercurial repository. +| $ cd $HOME +| $ hg clone https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/ cfcfd3 + +This takes about 40 seconds on campus at UQ. +It may take much longer, depending on your internet connection. -| $ cd ~ -| $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3 -| $ cd cfcfd3/extern/ -| $ hg clone ssh://cfcfd3@triton/cea2-hg cea2 +To see what's changed: + +| $ cd cfcfd3 +| $ hg incoming https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/ +| ... +| $ hg pull -u https://cfcfdlocal@triton.pselab.uq.edu.au/cfcfd3-hg/cfcfd3-hg/ Notes #. You will need a password for any access. Please ask. -#. To push code changes, you will need access via ssh. +#. You can read but not write with the "cfcfdlocal" username. +#. Some usernames (by negotiation) may push changesets back to the repository. Your computational environment @@ -74,17 +84,16 @@ #. gnuplot -Getting the cfcfd2 (old) codes ------------------------------- -The older cfcfd2 code collection is still available using bazaar-ng. -To get (read-only) access via http, use the command: +SSH access to the repository for developers +------------------------------------------- +Alternative access to the Mercurial repository for developers is possible via ssh. +You will need the password or your public key installed for any access. Please ask. -| cd $HOME -| bzr branch http://cfcfdlocal@triton.pselab.uq.edu.au/bzr-cfcfd2 cfcfd2 - -Notes - -#. You will need a password for bzr access. Please ask. -#. To push code changes, you will need access via ssh. +| $ cd ~ +| $ hg clone ssh://cfcfd3@triton/cfcfd3-hg cfcfd3 +| $ cd cfcfd3/extern/ +| $ hg clone ssh://cfcfd3@triton/cea2-hg cea2 + +