From c009a3268e83fc71f73e3eac1c4bcf3a28a1beac Mon Sep 17 00:00:00 2001 From: Jürgen Knödlseder Date: Wed, 6 Mar 2019 12:30:45 +0100 Subject: [PATCH] Add known issue about compiling against conda --- doc/source/help/issues.rst | 149 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---------------------------------------------------------- 1 file changed, 91 insertions(+), 58 deletions(-) diff --git a/doc/source/help/issues.rst b/doc/source/help/issues.rst index 4df70ef..5bd1fe2 100644 --- a/doc/source/help/issues.rst +++ b/doc/source/help/issues.rst @@ -5,11 +5,95 @@ Known issues Below you will find a list of known issues. +**Compilation issues** + +- :ref:`GammaLib does not compile against conda Python ` +- :ref:`GammaLib does not compile on Mac OS X ` +- :ref:`GammaLib does not compile on Solaris ` +- :ref:`GammaLib does not compile on OpenSolaris ` + +**Unit testing issues** + - :ref:`Many (but not all) unit tests fail ` + +**Other issues** + - :ref:`Python module does not work ` -- :ref:`Mac OS X ` -- :ref:`Solaris ` -- :ref:`OpenSolaris ` + +Compilation issues +^^^^^^^^^^^^^^^^^^ + +.. _conda_python: + +.. topic:: GammaLib does not compile against conda Python + + Trying to compile GammaLib against conda Python may fail due to + incompatibility issues. If you'd like to compile GammaLib against conda + Python, make sure that gcc, swig, and cfitsio are all installed via + anaconda + + .. code-block:: bash + + $ conda install gcc swig + $ conda install -c conda-forge cfitsio + +.. _issue_macosx: + +.. topic:: GammaLib does not compile on Mac OS X + + Dependent on the Mac OS X version you are using, not everything that + is needed to install GammaLib may be available (e.g. automake, libtool, + etc...). The easiest way to get the needed software is using a package + management system such as `MacPorts `_ or + `Homebrew `_. On a fresh El Capitan install you need + for example the following from `Homebrew `_: + + .. code-block:: bash + + $ brew install automake + $ brew install libtool + $ brew install cfitsio + $ brew install swig + + `swig `_ is only necessary if you installed the + code from git. Dependening on your system, you also may need to install + the Python development package. + +.. _issue_solaris: + +.. topic:: GammaLib does not compile on Solaris + + Although GammaLib builds on Solaris using the Sun compiler, there are + problems with global symbols in shared libraries and exception catching, + which prevents the FITS interface to work correctly. GammaLib has + however been built and tested successfully using the GNU compiler, and + this is the only build method that is currently supported. Problems have + also been encountered when compiling cfitsio versions more recent than + 3.250. The problems have been reported to the cfitsio developer team, + and are likely to be solved in the future. For the time being, it is + recommended to use cfitsio version 3.250 on Solaris. + +.. _issue_opensolaris: + +.. topic:: GammaLib does not compile on OpenSolaris + + On OpenSolaris, the same problems concerning the SunStudio compiler + occur as for Solaris, and also here, the GNU compiler is the recommended + tool to build GammaLib. Also here, cfitsio version 3.250 is the + recommended library as more recent version feature relocation + problems. GammaLib has been tested using gcc 4.3.2 on OpenSolaris + 2009.06. Make sure to create the following symbolic links if they do + not yet exist on your system: + + .. code-block:: bash + + $ ln -s /usr/bin/gcc4.3.2 /usr/bin/gcc + $ ln -s /usr/bin/g++4.3.2 /usr/bin/g++ + + They avoid excess warnings during compilation. + +Unit testing issues +^^^^^^^^^^^^^^^^^^^ .. _issue_test_fail: @@ -48,6 +132,10 @@ Below you will find a list of known issues. on Mac OS X (``/directory/to/lib`` should be replaced by the correct library path on your system). + +Other issues +^^^^^^^^^^^^ + .. _issue_python: .. topic:: Python module does not work @@ -71,58 +159,3 @@ Below you will find a list of known issues. but if the wrappers don't exist you need `swig `_. If the ``Python.h`` header file does not exist then install the Python development package. - -.. _issue_macosx: - -.. topic:: Mac OS X - - Dependent on the Mac OS X version you are using, not everything that - is needed to install GammaLib may be available (e.g. automake, libtool, - etc...). The easiest way to get the needed software is using a package - management system such as `MacPorts `_ or - `Homebrew `_. On a fresh El Capitan install you need - for example the following from `Homebrew `_: - - .. code-block:: bash - - $ brew install automake - $ brew install libtool - $ brew install cfitsio - $ brew install swig - - `swig `_ is only necessary if you installed the - code from git. Dependening on your system, you also may need to install - the Python development package. - -.. _issue_solaris: - -.. topic:: Solaris - - Although GammaLib builds on Solaris using the Sun compiler, there are - problems with global symbols in shared libraries and exception catching, - which prevents the FITS interface to work correctly. GammaLib has - however been built and tested successfully using the GNU compiler, and - this is the only build method that is currently supported. Problems have - also been encountered when compiling cfitsio versions more recent than - 3.250. The problems have been reported to the cfitsio developer team, - and are likely to be solved in the future. For the time being, it is - recommended to use cfitsio version 3.250 on Solaris. - -.. _issue_opensolaris: - -.. topic:: OpenSolaris - - On OpenSolaris, the same problems concerning the SunStudio compiler - occur as for Solaris, and also here, the GNU compiler is the recommended - tool to build GammaLib. Also here, cfitsio version 3.250 is the - recommended library as more recent version feature relocation - problems. GammaLib has been tested using gcc 4.3.2 on OpenSolaris - 2009.06. Make sure to create the following symbolic links if they do - not yet exist on your system: - - .. code-block:: bash - - $ ln -s /usr/bin/gcc4.3.2 /usr/bin/gcc - $ ln -s /usr/bin/g++4.3.2 /usr/bin/g++ - - They avoid excess warnings during compilation. -- libgit2 0.21.4