Veronika Vodeb / ctools

Commit b680aa1e70ae616a507c334896bd1152feef30fa

Authored by Jürgen Knödlseder
1 parent 1460f061

Reorganise ctools installation documentation and add information about conda and binary installs

Inline Side-by-side
Showing 14 changed files with 269 additions and 201 deletions
doc/source/admin/download.rst
  View file @b680aa1
... ... @@ -3,16 +3,6 @@
3 3 Download
4 4 ========
5 5  
6   -ctools can be obtained in form of releases or directly from the git
7   -development repository. Prefer a release if you intend using ctools
8   -for production (and publications). Clone the code from git if you need
9   -the most recent code that implements new features and corrects known
10   -bugs.
11   -
12   -
13   -Releases
14   ---------
15   -
16 6 The latest ctools release is ``ctools-1.4.3`` (31 October 2017).
17 7  
18 8 Below a table of ctools releases. Please read the :ref:`sec_release` to
... ... @@ -21,170 +11,93 @@ learn more about new features and corrected bugs in a given release.
21 11 .. warning::
22 12 At this stage of the project there is a strict link between the ctools and
23 13 gammalib versions. Please make sure that you have the corresponding gammalib
24   - version installed before installing ctools. The Mac OS X packages comprise
25   - both ctools and gammalib.
26   -
27   -.. list-table::
28   - :header-rows: 1
29   - :widths: 5 5 10
30   -
31   - * - ctools
32   - - gammalib
33   - - Mac OS X package
34   - * - `1.4.3 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.3.tar.gz>`_
35   - - `1.4.3 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.3.tar.gz>`_
36   - - `ctools-1.4.3-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.3-macosx10.7.dmg>`_
37   - * - `1.4.2 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.2.tar.gz>`_
38   - - `1.4.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.2.tar.gz>`_
39   - - `ctools-1.4.2-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.2-macosx10.7.dmg>`_
40   - * - `1.4.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.1.tar.gz>`_
41   - - `1.4.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.1.tar.gz>`_
42   - - `ctools-1.4.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.1-macosx10.7.dmg>`_
43   - * - `1.4.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.0.tar.gz>`_
44   - - `1.4.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.0.tar.gz>`_
45   - - `ctools-1.4.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.0-macosx10.7.dmg>`_
46   - * - `1.3.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.1.tar.gz>`_
47   - - `1.3.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.1.tar.gz>`_
48   - - `ctools-1.3.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.1-macosx10.7.dmg>`_
49   - * - `1.3.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.0.tar.gz>`_
50   - - `1.3.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.0.tar.gz>`_
51   - - `ctools-1.3.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.0-macosx10.7.dmg>`_
52   - * - `1.2.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.1.tar.gz>`_
53   - - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
54   - - `ctools-1.2.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.1-macosx10.7.dmg>`_
55   - * - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.0.tar.gz>`_
56   - - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
57   - - `ctools-1.2.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.0-macosx10.7.dmg>`_
58   - * - `1.1.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.1.0.tar.gz>`_
59   - - `1.1.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.1.0.tar.gz>`_
60   - - `ctools-1.1.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.1.0-macosx10.3.dmg>`_
61   - * - `1.0.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.1.tar.gz>`_
62   - - `1.0.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.1.tar.gz>`_
63   - - `ctools-1.0.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.1-macosx10.3.dmg>`_
64   - * - `1.0.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.0.tar.gz>`_
65   - - `1.0.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.0.tar.gz>`_
66   - - `ctools-1.0.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.0-macosx10.3.dmg>`_
67   - * - `0.10.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.10.0.tar.gz>`_
68   - - `0.11.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-0.11.0.tar.gz>`_
69   - - `ctools-0.10.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.10.0-macosx10.3.dmg>`_
70   - * - `0.9.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.0.tar.gz>`_
71   - - `0.10.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-0.10.0.tar.gz>`_
72   - - `ctools-0.9.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.1-macosx10.3.dmg>`_
73   - * - `0.8.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01.tar.gz>`_
74   - - `0.9.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-09-01.tar.gz>`_
75   - - `ctools-00-08-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01-macosx10.3.dmg>`_
76   - * - `0.8.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-00.tar.gz>`_
77   - - `0.9.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-09-00.tar.gz>`_
78   - - `ctools-00-08-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-00-macosx10.3.dmg>`_
79   - * - `0.7.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-01.tar.gz>`_
80   - - `0.8.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-08-01.tar.gz>`_
81   - - `ctools-00-07-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-01-macosx10.3.dmg>`_
82   - * - `0.7.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-00.tar.gz>`_
83   - - `0.8.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-08-00.tar.gz>`_
84   - - `ctools-00-07-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-00-macosx10.3.dmg>`_
85   - * - `0.6.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-06-00.tar.gz>`_
86   - - `0.7.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-07-00.tar.gz>`_
87   - - `ctools-00-06-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-06-00-macosx10.3.dmg>`_
88   - * - `0.5.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-01.tar.gz>`_
89   - - `0.6.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-06-02.tar.gz>`_
90   - - `ctools-00-05-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-01-macosx10.3.dmg>`_
91   - * - `0.5.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-00.tar.gz>`_
92   - - `0.6.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-06-01.tar.gz>`_
93   - - `ctools-00-05-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-00-macosx10.3.dmg>`_
94   - * - `0.4.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-04-00.tar.gz>`_
95   - - `0.5.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-05-00.tar.gz>`_
96   - - `ctools-00-04-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-04-00-macosx10.3.dmg>`_
97   - * - `0.3.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-03-00.tar.gz>`_
98   - - `0.4.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-02.tar.gz>`_
99   - - `ctools-00-03-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-03-00-macosx10.3.dmg>`_
100   - * - `0.2.5 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-05.tar.gz>`_
101   - - `0.4.11 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-11.tar.gz>`_
102   - -
103   - * - `0.2.4 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-04.tar.gz>`_
104   - - `0.4.10 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-10.tar.gz>`_
105   - -
106   - * - `0.2.3 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-03.tar.gz>`_
107   - - `0.4.9 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-09.tar.gz>`_
108   - -
109   - * - `0.2.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-01.tar.gz>`_
110   - - `0.4.7 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-07.tar.gz>`_
111   - -
112   -
113   -
114   -Development release
115   --------------------
116   -
117   -The current ctools development release is ``ctools-1.5.0.dev1``.
118   -This release reflects the status of the current ``devel`` branch of
119   -the ctools git repository.
120   -
121   -* `Mac OS X binary package <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.5.0.dev1-macosx10.7.dmg>`_ (Mac OS X 10.7+)
122   -* `GammaLib <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.5.0.dev1.tar.gz>`_ source code tarball
123   -* `ctools <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.5.0.dev1.tar.gz>`_ source code tarball
124   -
125   -
126   -Git repository
127   ---------------
128   -
129   -To clone the gammalib and ctools source codes, type
130   -
131   -.. code-block:: bash
132   -
133   - $ git clone https://cta-gitlab.irap.omp.eu/gammalib/gammalib.git
134   - $ git clone https://cta-gitlab.irap.omp.eu/ctools/ctools.git
135   -
136   -This will create directories named gammalib and ctools under the current
137   -working directory that will contain the gammalib and ctools source code.
138   -In case that the cloning does not work you may try adding
139   -
140   -.. code-block:: bash
141   -
142   - $ export GIT_SSL_NO_VERIFY=true
143   -
144   -or
145   -
146   -.. code-block:: bash
147   -
148   - $ git config --global http.sslverify "false"
149   -
150   -before retrieving the code.
151   -Before you will be able to compile the code you need to generate the
152   -configuration file using the ``autogen.sh`` script.
153   -Also make sure that you're actually on the devel branch of the git
154   -repository. GammaLib and ctools can be compiled and configured using
155   -the following command sequence (the code will be installed into the
156   -``/usr/local/gamma`` directory):
157   -
158   -.. code-block:: bash
159   -
160   - $ cd gammalib
161   - $ git checkout devel
162   - $ ./autogen.sh
163   - $ ./configure
164   - $ make
165   - $ make check
166   - $ sudo make install
167   - $ export GAMMALIB=/usr/local/gamma
168   - $ source $GAMMALIB/bin/gammalib-init.sh
169   - $ cd ../ctools
170   - $ git checkout devel
171   - $ ./autogen.sh
172   - $ ./configure
173   - $ make
174   - $ make check
175   - $ sudo make install
176   - $ export CTOOLS=/usr/local/gamma
177   - $ source $CTOOLS/bin/ctools-init.sh
178   -
179   -Please read the :ref:`sec_install` section if you need more information on
180   -how to install ctools.
181   -
182   -.. note::
183   -
184   - You need `swig <http://www.swig.org/>`_ on your system to build the
185   - Python wrappers when you get the code from Git. Python wrappers are
186   - not stored in the Git repository but are built using
187   - `swig <http://www.swig.org/>`_ from interface files located in the
188   - pyext folder. However, you do not need `swig <http://www.swig.org/>`_
189   - when fetching a release as the Python wrappers are bundled with the
190   - release tarballs.
  14 + version installed before installing ctools. The Mac OS X binary packages
  15 + comprise both ctools and gammalib.
  16 +
  17 +..
  18 +
  19 + .. list-table::
  20 + :header-rows: 1
  21 + :widths: 5 5 10
  22 +
  23 + * - ctools
  24 + - gammalib
  25 + - Mac OS X (10.7+) binary disk image
  26 + * - `1.4.3 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.3.tar.gz>`_
  27 + - `1.4.3 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.3.tar.gz>`_
  28 + - `ctools-1.4.3-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.3-macosx10.7.dmg>`_
  29 + * - `1.4.2 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.2.tar.gz>`_
  30 + - `1.4.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.2.tar.gz>`_
  31 + - `ctools-1.4.2-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.2-macosx10.7.dmg>`_
  32 + * - `1.4.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.1.tar.gz>`_
  33 + - `1.4.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.1.tar.gz>`_
  34 + - `ctools-1.4.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.1-macosx10.7.dmg>`_
  35 + * - `1.4.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.0.tar.gz>`_
  36 + - `1.4.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.4.0.tar.gz>`_
  37 + - `ctools-1.4.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.4.0-macosx10.7.dmg>`_
  38 + * - `1.3.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.1.tar.gz>`_
  39 + - `1.3.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.1.tar.gz>`_
  40 + - `ctools-1.3.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.1-macosx10.7.dmg>`_
  41 + * - `1.3.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.0.tar.gz>`_
  42 + - `1.3.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.3.0.tar.gz>`_
  43 + - `ctools-1.3.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.3.0-macosx10.7.dmg>`_
  44 + * - `1.2.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.1.tar.gz>`_
  45 + - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
  46 + - `ctools-1.2.1-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.1-macosx10.7.dmg>`_
  47 + * - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.0.tar.gz>`_
  48 + - `1.2.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.2.0.tar.gz>`_
  49 + - `ctools-1.2.0-macosx10.7.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.2.0-macosx10.7.dmg>`_
  50 + * - `1.1.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.1.0.tar.gz>`_
  51 + - `1.1.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.1.0.tar.gz>`_
  52 + - `ctools-1.1.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.1.0-macosx10.3.dmg>`_
  53 + * - `1.0.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.1.tar.gz>`_
  54 + - `1.0.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.1.tar.gz>`_
  55 + - `ctools-1.0.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.1-macosx10.3.dmg>`_
  56 + * - `1.0.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.0.tar.gz>`_
  57 + - `1.0.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.0.0.tar.gz>`_
  58 + - `ctools-1.0.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.0.0-macosx10.3.dmg>`_
  59 + * - `0.10.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.10.0.tar.gz>`_
  60 + - `0.11.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-0.11.0.tar.gz>`_
  61 + - `ctools-0.10.0-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.10.0-macosx10.3.dmg>`_
  62 + * - `0.9.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.0.tar.gz>`_
  63 + - `0.10.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-0.10.0.tar.gz>`_
  64 + - `ctools-0.9.1-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-0.9.1-macosx10.3.dmg>`_
  65 + * - `0.8.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01.tar.gz>`_
  66 + - `0.9.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-09-01.tar.gz>`_
  67 + - `ctools-00-08-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-01-macosx10.3.dmg>`_
  68 + * - `0.8.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-00.tar.gz>`_
  69 + - `0.9.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-09-00.tar.gz>`_
  70 + - `ctools-00-08-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-08-00-macosx10.3.dmg>`_
  71 + * - `0.7.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-01.tar.gz>`_
  72 + - `0.8.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-08-01.tar.gz>`_
  73 + - `ctools-00-07-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-01-macosx10.3.dmg>`_
  74 + * - `0.7.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-00.tar.gz>`_
  75 + - `0.8.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-08-00.tar.gz>`_
  76 + - `ctools-00-07-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-07-00-macosx10.3.dmg>`_
  77 + * - `0.6.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-06-00.tar.gz>`_
  78 + - `0.7.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-07-00.tar.gz>`_
  79 + - `ctools-00-06-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-06-00-macosx10.3.dmg>`_
  80 + * - `0.5.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-01.tar.gz>`_
  81 + - `0.6.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-06-02.tar.gz>`_
  82 + - `ctools-00-05-01-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-01-macosx10.3.dmg>`_
  83 + * - `0.5.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-00.tar.gz>`_
  84 + - `0.6.1 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-06-01.tar.gz>`_
  85 + - `ctools-00-05-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-05-00-macosx10.3.dmg>`_
  86 + * - `0.4.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-04-00.tar.gz>`_
  87 + - `0.5.0 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-05-00.tar.gz>`_
  88 + - `ctools-00-04-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-04-00-macosx10.3.dmg>`_
  89 + * - `0.3.0 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-03-00.tar.gz>`_
  90 + - `0.4.2 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-02.tar.gz>`_
  91 + - `ctools-00-03-00-macosx10.3.dmg <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-03-00-macosx10.3.dmg>`_
  92 + * - `0.2.5 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-05.tar.gz>`_
  93 + - `0.4.11 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-11.tar.gz>`_
  94 + -
  95 + * - `0.2.4 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-04.tar.gz>`_
  96 + - `0.4.10 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-10.tar.gz>`_
  97 + -
  98 + * - `0.2.3 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-03.tar.gz>`_
  99 + - `0.4.9 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-09.tar.gz>`_
  100 + -
  101 + * - `0.2.1 <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-00-02-01.tar.gz>`_
  102 + - `0.4.7 <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-00-04-07.tar.gz>`_
  103 + -
... ...
doc/source/admin/index.rst
  View file @b680aa1
... ... @@ -6,7 +6,9 @@ Getting ctools
6 6 .. toctree::
7 7 :maxdepth: 1
8 8  
9   - install_source
10 9 install_conda
  10 + install_source
  11 + install_binary
  12 + install_devel
11 13 download
12 14 release_history/index
... ...
doc/source/admin/install_binary.rst 0 → 100644
  View file @b680aa1
  1 +.. _sec_install_binary:
  2 +
  3 +Installing as binary package
  4 +============================
  5 +
  6 +Mac OS X
  7 +--------
  8 +
  9 +After :ref:`downloading the Mac OS X binary disk image <sec_download>`
  10 +double-click on the image to mount the disk
  11 +
  12 +.. image:: macosx-disk-image.jpg
  13 + :height: 300px
  14 + :alt: Mac OS X binary disk image
  15 + :align: center
  16 +
  17 +Now open the installer package by right-clicking (ctrl-click) on the installer
  18 +package icon. This allows to install a software package with an invalid
  19 +certificate (ctools has so far no Apple certificate)
  20 +
  21 +.. image:: macosx-open-package.jpg
  22 + :height: 300px
  23 + :alt: Open installer package
  24 + :align: center
  25 +
  26 +A window will show up, warning that the package comes from an unidentified
  27 +developer. Click on ``Open`` to continue.
  28 +
  29 +.. image:: macosx-unidentified.jpg
  30 + :height: 200px
  31 + :alt: Unidentified developer warning
  32 + :align: center
  33 +
  34 +Now the installer opens, warning that the package has been signed with an
  35 +invalid certificate. Click on ``Continue`` to proceed.
  36 +
  37 +.. image:: macosx-invalid-cert.jpg
  38 + :height: 300px
  39 + :alt: Invalid certificate warning
  40 + :align: center
  41 +
  42 +Follow now the installer instructions by clicking on ``Continue``. As the
  43 +software will be installed in ``/usr/local/gamma`` the installer will ask
  44 +you for the ``root`` password on your machine.
  45 +
  46 +.. image:: macosx-installer.jpg
  47 + :height: 300px
  48 + :alt: Installer introduction
  49 + :align: center
  50 +
  51 +At the end you should see a window like this:
  52 +
  53 +.. image:: macosx-installed.jpg
  54 + :height: 300px
  55 + :alt: Installer summary
  56 + :align: center
  57 +
... ...
doc/source/admin/install_conda.rst
  View file @b680aa1
1 1 .. _sec_install_conda:
2 2  
3   -Installing via conda
4   -====================
  3 +Installing via Anaconda
  4 +=======================
5 5  
6 6 `Anaconda <https://www.anaconda.com/download/>`_ (you can also use
7 7 `Miniconda <https://conda.io/miniconda.html>`_ for a smaller footprint) is a
... ... @@ -11,7 +11,8 @@ Anaconda Python version. An Anaconda Python installation is completely separate
11 11 from any existing system wide or user space Python installation, so Anaconda
12 12 can be tested without the fear of breaking an existing installation.
13 13  
14   -Anaconda works on most systems without root access!
  14 +**Anaconda ctools packages exist for Mac OS X and Linux distributions. Windows
  15 +is not supported.**
15 16  
16 17  
17 18 Installing
... ... @@ -30,7 +31,8 @@ Installing
30 31 - We strongly recommend to work with separate Anaconda environments, and
31 32 especially not use the special root environment (that is used for all conda
32 33 commands and environment manipulations, package installations etc.) for
33   - anything besides updating the conda package itself (if necessary):
  34 + anything besides updating the conda package itself. For example create
  35 + a ``myenv`` environment as follows:
34 36  
35 37 .. code-block:: bash
36 38  
... ...
doc/source/admin/install_devel.rst 0 → 100644
  View file @b680aa1
  1 +.. _sec_install_devel:
  2 +
  3 +Installing the development version
  4 +==================================
  5 +
  6 +The current development version of the code can be downloaded as source
  7 +tarballs, Mac OS X binaries, or directly from the `Git <https://git-scm.com/>`_
  8 +repository.
  9 +
  10 +The current ctools development release is ``ctools-1.5.0.dev1``.
  11 +
  12 +
  13 +Source tarballs
  14 +---------------
  15 +
  16 +Download the source tarballs from the following links
  17 +
  18 +- `ctools <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.5.0.dev1.tar.gz>`_
  19 +- `GammaLib <http://cta.irap.omp.eu/ctools/releases/gammalib/gammalib-1.5.0.dev1.tar.gz>`_
  20 +
  21 +and follow the instructions on :ref:`sec_install_source`.
  22 +
  23 +
  24 +Binary packages
  25 +---------------
  26 +
  27 +Download the installer image from the following link
  28 +
  29 +- `Mac OS X (10.7+) <http://cta.irap.omp.eu/ctools/releases/ctools/ctools-1.5.0.dev1-macosx10.7.dmg>`_
  30 +
  31 +and follow the instructions on :ref:`sec_install_binary`.
  32 +
  33 +
  34 +Git repository
  35 +--------------
  36 +
  37 +To clone the gammalib and ctools source codes, type
  38 +
  39 +.. code-block:: bash
  40 +
  41 + $ git clone https://cta-gitlab.irap.omp.eu/gammalib/gammalib.git
  42 + $ git clone https://cta-gitlab.irap.omp.eu/ctools/ctools.git
  43 +
  44 +This will create directories named gammalib and ctools under the current
  45 +working directory that will contain the gammalib and ctools source code.
  46 +In case that the cloning does not work you may try adding
  47 +
  48 +.. code-block:: bash
  49 +
  50 + $ export GIT_SSL_NO_VERIFY=true
  51 +
  52 +or
  53 +
  54 +.. code-block:: bash
  55 +
  56 + $ git config --global http.sslverify "false"
  57 +
  58 +before retrieving the code.
  59 +Before you will be able to compile the code you need to generate the
  60 +configuration file using the ``autogen.sh`` script.
  61 +Also make sure that you're actually on the devel branch of the git
  62 +repository. GammaLib and ctools can be compiled and configured using
  63 +the following command sequence (the code will be installed into the
  64 +``/usr/local/gamma`` directory):
  65 +
  66 +.. code-block:: bash
  67 +
  68 + $ cd gammalib
  69 + $ git checkout devel
  70 + $ ./autogen.sh
  71 + $ ./configure
  72 + $ make
  73 + $ make check
  74 + $ sudo make install
  75 + $ export GAMMALIB=/usr/local/gamma
  76 + $ source $GAMMALIB/bin/gammalib-init.sh
  77 + $ cd ../ctools
  78 + $ git checkout devel
  79 + $ ./autogen.sh
  80 + $ ./configure
  81 + $ make
  82 + $ make check
  83 + $ sudo make install
  84 + $ export CTOOLS=/usr/local/gamma
  85 + $ source $CTOOLS/bin/ctools-init.sh
  86 +
  87 +Please read the :ref:`sec_install_source` section if you need more information
  88 +on how to install ctools.
  89 +
  90 +.. note::
  91 + You need `swig <http://www.swig.org/>`_ on your system to build the
  92 + Python wrappers when you get the code from Git. Python wrappers are
  93 + not stored in the Git repository but are built using
  94 + `swig <http://www.swig.org/>`_ from interface files located in the
  95 + pyext folder. However, you do not need `swig <http://www.swig.org/>`_
  96 + when fetching a release as the Python wrappers are bundled with the
  97 + release tarballs.
... ...
doc/source/admin/install_source.rst
  View file @b680aa1
1   -.. _sec_compiling_source:
  1 +.. _sec_install_source:
  2 +
  3 +Installing from source code
  4 +===========================
  5 +
  6 +Compiling ctools from source is the recommended method to install the package
  7 +in case that you do not use Anaconda (if you use Anaconda, please follow
  8 +the instructions at :ref:`sec_install_conda`, and better do not try to compile
  9 +the source code against your Anaconda Python installation). You also need to
  10 +compile from source if you want to use the development version of ctools.
2 11  
3   -Compiling from source
4   -=====================
5 12  
6 13 Before you start
7 14 ----------------
... ... @@ -24,8 +31,6 @@ software:
24 31 is highly recommended to enable dynamic scripting of ctools and
25 32 developing and using of cscripts.
26 33  
27   -No system administrator privileges are needed to install ctools.
28   -
29 34  
30 35 Installing GammaLib
31 36 -------------------
... ...
doc/source/admin/macosx-disk-image.jpg 0 → 100644
View file @b680aa1

90.3 KB
doc/source/admin/macosx-installed.jpg 0 → 100644
View file @b680aa1

111 KB
doc/source/admin/macosx-installer.jpg 0 → 100644
View file @b680aa1

92.7 KB
doc/source/admin/macosx-invalid-cert.jpg 0 → 100644
View file @b680aa1

114 KB
doc/source/admin/macosx-open-package.jpg 0 → 100644
View file @b680aa1

136 KB
doc/source/admin/macosx-unidentified.jpg 0 → 100644
View file @b680aa1

85.3 KB
doc/source/admin/release_history/1.5.rst
  View file @b680aa1
... ... @@ -38,7 +38,7 @@ Improvements
38 38 * [`2260 <https://cta-redmine.irap.omp.eu/issues/2260>`_] -
39 39 Handle On/Off observations by :ref:`cspull`
40 40 * [`2237 <https://cta-redmine.irap.omp.eu/issues/2237>`_] -
41   - Add ``statistic`` parameters to :ref:`ctbutterfly`, :ref:`cterror`,
  41 + Add ``statistic`` parameter to :ref:`ctbutterfly`, :ref:`cterror`,
42 42 :ref:`cttsmap`, :ref:`ctulimit`, :ref:`cslightcrv`, :ref:`csphasecrv`,
43 43 :ref:`cspull`, :ref:`cssens`, :ref:`csspec`, :ref:`cstsdist` and
44 44 :ref:`cstsmapsplit`
... ...
doc/source/admin/release_history/index.rst
  View file @b680aa1
... ... @@ -3,29 +3,21 @@
3 3 Release History
4 4 ===============
5 5  
6   -Major releases:
7   -
8 6 .. toctree::
9 7 :maxdepth: 1
10 8  
11 9 ctools 1.5 <1.5>
12   - ctools 1.4 <1.4>
13   - ctools 1.3 <1.3>
14   - ctools 1.2 <1.2>
15   - ctools 1.1 <1.1>
16   - ctools 1.0 <1.0>
17   -
18   -Bug fix releases:
19   -
20   -.. toctree::
21   - :maxdepth: 1
22   -
23 10 ctools 1.4.3 <1.4.3>
24 11 ctools 1.4.2 <1.4.2>
25 12 ctools 1.4.1 <1.4.1>
  13 + ctools 1.4 <1.4>
26 14 ctools 1.3.1 <1.3.1>
  15 + ctools 1.3 <1.3>
27 16 ctools 1.2.1 <1.2.1>
  17 + ctools 1.2 <1.2>
  18 + ctools 1.1 <1.1>
28 19 ctools 1.0.1 <1.0.1>
  20 + ctools 1.0 <1.0>
29 21  
30 22 For older ctools versions see
31 23 `here <https://cta-redmine.irap.omp.eu/projects/ctools/wiki/Release_notes>`_.
... ...