Skip to content

Commit 4ec03fa

Browse files
l-korousl-korous
committed
Work on docs.
1 parent 39d81e8 commit 4ec03fa

File tree

8 files changed

+85
-30
lines changed

8 files changed

+85
-30
lines changed

‎doc/src/collaboration.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Once your public SSH key is registered at Github, you can
5454
clone the Hermes repository from your Github account to
5555
your local computer. This is done by typing::
5656

57-
git clone git@github.com:your_name/hermes.git
57+
git clone https://github.com/your_name/hermes.git
5858

5959
Now you can build Hermes as described in the Installation
6060
section above.
@@ -179,7 +179,7 @@ is to first push them to your Github fork and then send
179179
a pull request to the Hermes network. To push your
180180
changes, type::
181181

182-
git push git@github.com:your_name/hermes.git test-1:test-1
182+
git push https://github.com/your_name/hermes.git test-1:test-1
183183

184184
This will push your local branch test-1 to a branch of the
185185
same name at Github. Now you can go back to your Github account,

‎doc/src/installation/linux.rst

+19-20
Original file line numberDiff line numberDiff line change
@@ -20,30 +20,13 @@ Download and compilation
2020

2121
The rest of the instructions here are for building Hermes from source.
2222

23-
If you are using a Debian-based system, install the (required) libraries first:
23+
If you are using a Debian-based system, install the (required) libraries first::
2424

25-
.. sourcecode::
26-
.
27-
28-
apt-get install git git-core cmake g++ freeglut3-dev libsuitesparse-dev libglew-dev libxerces-c-dev xsdcxx libmatio-dev
29-
30-
If you want to use fast saving / loading of Hermes entities, install
31-
32-
- BSON
33-
34-
- Clone the BSON Mongo driver git repository from [email protected]:l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
35-
- Compile and install using 'make install'
36-
37-
For thread caching memory allocator from Google, see
38-
39-
- TCMalloc
40-
41-
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
42-
- Make & install
25+
apt-get install git git-core cmake g++ freeglut3-dev libsuitesparse-dev libglew-dev libxerces-c-dev xsdcxx libmatio-dev gfortran
4326
4427
To obtain the source code, clone the Git repository from Github::
4528
46-
git clone git://github.com/hpfem/hermes.git
29+
git clone https://github.com/hpfem/hermes.git
4730

4831
These two repositories are synchronized. For more advanced users we recommend to
4932
create a free account at `Github <http://github.com>`_ (if you do not have one yet),
@@ -104,6 +87,22 @@ In Eclipse:
10487
- Browse where your build tree is and select the root build tree directory.
10588
- Keep "Copy projects into workspace" unchecked.
10689

90+
Optional external packages
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~
92+
93+
[OPTIONAL] If you want to use fast saving / loading of Hermes entities, install
94+
95+
- BSON
96+
97+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
98+
- Compile and install using 'make install'
99+
100+
[OPTIONAL] For thread caching memory allocator from Google, see
101+
102+
- TCMalloc
103+
104+
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
105+
- Make & install
107106

108107
Install Hermes
109108
~~~~~~~~~~~~~~

‎doc/src/installation/matrix_solvers/mumps.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ following line (or append to the existing one)::
2626

2727
set(WITH_MUMPS YES)
2828

29-
Finally execute::
29+
Finally execute (first line is deleting the CMake cache just to be sure we have a clean build)::
3030
3131
rm CMakeCache.txt
3232
cmake .

‎doc/src/installation/matrix_solvers/petsc.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,21 @@ following line (or append to the existing one)::
2020

2121
set(WITH_PETSC YES)
2222

23-
Finally execute::
23+
Finally execute
24+
25+
[OPTIONAL] If you want to use fast saving / loading of Hermes entities, install
26+
27+
- BSON
28+
29+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
30+
- Compile and install using 'make install'
31+
32+
[OPTIONAL] For thread caching memory allocator from Google, see
33+
34+
- TCMalloc
35+
36+
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
37+
- Make & install::
2438
2539
rm CMakeCache.txt
2640
cmake .

‎doc/src/installation/matrix_solvers/superlu.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,21 @@ following lines (or append to the existing one)::
2424
set(SUPERLU_ROOT ~/solvers/superlu_mt) #(or your own installation destination)
2525
set(SUPERLU_MT NO)
2626

27-
Finally execute::
27+
Finally execute
28+
29+
[OPTIONAL] If you want to use fast saving / loading of Hermes entities, install
30+
31+
- BSON
32+
33+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
34+
- Compile and install using 'make install'
35+
36+
[OPTIONAL] For thread caching memory allocator from Google, see
37+
38+
- TCMalloc
39+
40+
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
41+
- Make & install::
2842
2943
rm CMakeCache.txt
3044
cmake .

‎doc/src/installation/matrix_solvers/trilinos.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,21 @@ following line (or append to the existing one)::
1919

2020
set(WITH_TRILINOS YES)
2121

22-
Finally execute::
22+
Finally execute
23+
24+
[OPTIONAL] If you want to use fast saving / loading of Hermes entities, install
25+
26+
- BSON
27+
28+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
29+
- Compile and install using 'make install'
30+
31+
[OPTIONAL] For thread caching memory allocator from Google, see
32+
33+
- TCMalloc
34+
35+
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
36+
- Make & install::
2337
2438
rm CMakeCache.txt
2539
cmake .

‎doc/src/installation/matrix_solvers/umfpack.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,21 @@ following lines (or append to the existing one)::
1818

1919
set(WITH_UMFPACK YES)
2020

21-
and execute::
21+
and execute
22+
23+
[OPTIONAL] If you want to use fast saving / loading of Hermes entities, install
24+
25+
- BSON
26+
27+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip: `Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
28+
- Compile and install using 'make install'
29+
30+
[OPTIONAL] For thread caching memory allocator from Google, see
31+
32+
- TCMalloc
33+
34+
- Get TCMalloc from the SVN repository at `<http://code.google.com/p/gperftools/source/checkout>`_.
35+
- Make & install::
2236

2337
rm CMakeCache.txt
2438
cmake .

‎doc/src/installation/win.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The rest of the instructions here are for building Hermes from source.
2222

2323
To obtain the source code, clone the Git repository from Github::
2424
25-
git clone git://github.com/hpfem/hermes.git
25+
git clone https://github.com/hpfem/hermes.git
2626
2727
[IMPORTANT] As Hermes uses features of C++11 (such as initializer lists, nullptr_t, etc.), the only Visual Studio family compiler you can use is Visual Studio 2013 (both Express and 'Full' versions).
2828

@@ -117,7 +117,7 @@ Please note that e.g. TCMalloc, BSON, UMFPACK are also 'optional', but to get th
117117

118118
- BSON
119119

120-
- Clone the BSON Mongo driver git repository from git@github.com:l-korous/mongo-c-driver.git (if you don't know how, here is a tip:`Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
120+
- Clone the BSON Mongo driver git repository from https://github.com/l-korous/mongo-c-driver.git (if you don't know how, here is a tip:`Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
121121

122122
- Download SCONS build tool from `<http://sourceforge.net/projects/scons/files/latest/download?source=files>`_.
123123
- Install SCONS (you need to have PYTHON installed for that), run it (e.g. issuing C:\Python27\Scripts\scons.bat) in the BSON Mongo driver root directory
@@ -234,7 +234,7 @@ Dependency check-list - 64-bit
234234

235235
- BSON
236236

237-
- Clone the BSON Mongo driver git repository from git@github.com:l-korous/mongo-c-driver.git (if you don't know how, here is a tip:`Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
237+
- Clone the BSON Mongo driver git repository from `<https://github.com/l-korous/mongo-c-driver.git>`_ (if you don't know how, here is a tip:`Getting a Git Repository <http://git-scm.com/book/en/Git-Basics-Getting-a-Git-Repository>`_)
238238
- Download SCONS build tool from `<http://sourceforge.net/projects/scons/files/latest/download?source=files>`_.
239239
- Install SCONS (you need to have PYTHON installed for that), run it (e.g. issuing C:\Python27\Scripts\scons.bat) in the BSON Mongo driver root directory
240240

0 commit comments

Comments
 (0)