Skip to content

Commit

Permalink
Merge pull request #323 from LSSTDESC/gvalogia-patch-1
Browse files Browse the repository at this point in the history
Update installation issues in README.md
  • Loading branch information
elisachisari committed Feb 9, 2018
2 parents e87767f + a720d44 commit 24d8d76
Showing 1 changed file with 28 additions and 13 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,19 +64,6 @@ make
make install
```

## Known installation issues
1. If you are having issues with GSL versions linking, please try the following during the configuration step:
````sh
./configure CFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"
````
2. If you are having issues with FFTW linking, please make sure you have the latest version correctly installed. See more on [FFTW webpage](http://www.fftw.org/download.html)
3. If you move or delete the source directory after installing `CCL`, some functions may fail. The source directory contains files needed by CLASS (which is contained within `CCL`) at run-time.
4. If you are planning to compile your own file that calls `CCL`, then you should add the following to your .bashrc:
````sh
export LD_LIBRARY_PATH=/path/to/where/ccl/is/installed/lib:$LD_LIBRARY_PATH
````
5. We know of one case with Mac OS where `libtools` had the “lock” function set to “yes” and this caused the installation to stall. However, this is very rare. If this happens, after the `configure` step, edit `libtool` to set the “lock” to “no”.

## C++ compatibility
`CCL` library can be called from C++ code without any additional requirements or modifications. To make sure that there are no problems you can run
````sh
Expand Down Expand Up @@ -125,6 +112,34 @@ python setup.py uninstall

For quick introduction to `CCL` in Python look at notebooks in **_tests/_**.

## Known installation issues
1. If you are having issues with GSL versions linking, please try the following during the configuration step:
````sh
./configure CFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"
````
2. If you are having issues with FFTW linking, please make sure you have the latest version correctly installed. See more on [FFTW webpage](http://www.fftw.org/download.html)
3. If you move or delete the source directory after installing `CCL`, some functions may fail. The source directory contains files needed by CLASS (which is contained within `CCL`) at run-time.
4. If you are planning to compile your own file that calls `CCL`, then you should add the following to your .bashrc:
````sh
export LD_LIBRARY_PATH=/path/to/where/ccl/is/installed/lib:$LD_LIBRARY_PATH
````
5. We know of one case with Mac OS where `libtools` had the “lock” function set to “yes” and this caused the installation to stall. However, this is very rare. If this happens, after the `configure` step, edit `libtool` to set the “lock” to “no”.
6. We know of one case on a Mac OS where running
````sh
python setup.py install --user
````
produced the error

````sh
error: can't combine user with prefix, exec_prefix/home, or install_(plat)base
````
This issue can be solved by instead running
````sh
python setup.py install --user --prefix=
````
The issue is discussed in detail [here](https://stackoverflow.com/questions/4495120/combine-user-with-prefix-error-with-setup-py-install).
## Compiling against an external version of CLASS
The default installation procedure for `CCL` implies automatically downloading and installing a tagged version of `CLASS`. Optionally, you can also link `CCL` against an external version of `CLASS`. This is useful if you want to use a modified version of `CLASS`, or a different or more up-to-date version of the standard `CLASS`.
Expand Down

0 comments on commit 24d8d76

Please sign in to comment.