Merge pull request #349 from LSSTDESC/internal_tracer_functions

added functionality to return internal tracer functions (e.g. dndz)

doc/0000-ccl_note/main.tex

@@ -968,7 +968,7 @@ \section{Tests and validation}
 \section{Examples for C implementation}
 \label{sec:example}
 
-Examples of how to run \ccl are provided in the {\tt tests} sub-directory of the library. The first resource for a new user should be the {\tt ccl$\_$sample$\_$run.c} file. This starts by setting up the \ccl default configuration. Then, it creates the ``cosmo'' structure, which contains distances and power spectra splines, for example. There are example calls for routines that output comoving radial distances, the scale factor, the growth factor and $\sigma_8$. Toy models are created for the redshift distributions of galaxies in the clustering and lensing samples, and for the bias of the clustering sample ($b(z)=1+z$). These are used for constructing the ``tracer'' structures via {\tt CCL$\_$Cltracer}, which can then be called to obtain the angular power spectra for clustering, cosmic shear and galaxy lensing.
+Examples of how to run \ccl are provided in the {\tt tests} sub-directory of the library. The first resource for a new user should be the {\tt ccl$\_$sample$\_$run.c} file. This starts by setting up the \ccl default configuration. Then, it creates the ``cosmo'' structure, which contains distances and power spectra splines, for example. There are example calls for routines that output comoving radial distances, the scale factor, the growth factor and $\sigma_8$. Toy models are created for the redshift distributions of galaxies in the clustering and lensing samples, and for the bias of the clustering sample ($b(z)=1+z$). These are used for constructing the ``tracer'' structures via {\tt CCL$\_$Cltracer}, which can then be called to obtain the angular power spectra for clustering, cosmic shear and CMB lensing. All functions of redshift associated to each tracer can be retrieved at any arbitrary point using the same interpolation scheme used by \ccl internally.
 
 
 \section{Python wrapper}

doc/doxygen/Doxyfile

@@ -150,7 +150,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -790,7 +790,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../../src/ ../../include/ ../../tests/
+INPUT                  = ../src/ ../include/ ../tests/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

doc/html/annotated.html

@@ -105,10 +105,10 @@
 <tr id="row_13_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_int_lens_par.html" target="_self">IntLensPar</a></td><td class="desc"></td></tr>
 <tr id="row_14_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_int_mag_par.html" target="_self">IntMagPar</a></td><td class="desc"></td></tr>
 <tr id="row_15_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structnorm__params.html" target="_self">norm_params</a></td><td class="desc"></td></tr>
-<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpz__params.html" target="_self">pz_params</a></td><td class="desc"></td></tr>
-<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_sigma_r__pars.html" target="_self">SigmaR_pars</a></td><td class="desc"></td></tr>
-<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_spl_par.html" target="_self">SplPar</a></td><td class="desc"></td></tr>
-<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structuser__func__params.html" target="_self">user_func_params</a></td><td class="desc"></td></tr>
+<tr id="row_16_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_om_nuh2__params.html" target="_self">OmNuh2_params</a></td><td class="desc"></td></tr>
+<tr id="row_17_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structpz__params.html" target="_self">pz_params</a></td><td class="desc"></td></tr>
+<tr id="row_18_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_sigma_r__pars.html" target="_self">SigmaR_pars</a></td><td class="desc"></td></tr>
+<tr id="row_19_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="struct_spl_par.html" target="_self">SplPar</a></td><td class="desc"></td></tr>
 <tr id="row_20_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structuser__pz__info.html" target="_self">user_pz_info</a></td><td class="desc"></td></tr>
 </table>
 </div><!-- directory -->

doc/html/ccl_8h.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
-<title>CCL: /home/alonso/Downloads/Clean/CCL/include/ccl.h File Reference</title>
+<title>CCL: ccl.h File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>

doc/html/ccl_8h_source.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
-<title>CCL: /home/alonso/Downloads/Clean/CCL/include/ccl.h Source File</title>
+<title>CCL: ccl.h Source File</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>

doc/html/ccl__background_8c.html

@@ -4,7 +4,7 @@
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.11"/>
-<title>CCL: /home/alonso/Downloads/Clean/CCL/src/ccl_background.c File Reference</title>
+<title>CCL: ccl_background.c File Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
@@ -252,7 +252,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -348,7 +348,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -471,7 +471,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -512,7 +512,7 @@ <h2 class="groupheader">Function Documentation</h2>
   <table class="params">
     <tr><td class="paramname">cosmo</td><td>Cosmological parameters </td></tr>
     <tr><td class="paramname">a</td><td>scale factor, normalized to 1 today </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -649,7 +649,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -704,7 +704,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -800,7 +800,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -896,7 +896,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores H(a[i])/H0 </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -992,7 +992,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">na</td><td>Number of scale factors in a </td></tr>
     <tr><td class="paramname">a</td><td>array of scale factors </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the distance for a[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -1040,7 +1040,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">cosmo</td><td>Cosmological parameters </td></tr>
     <tr><td class="paramname">a</td><td>scale factor, normalized to 1 for today </td></tr>
     <tr><td class="paramname">label</td><td>species type. Available: 'matter' (0), 'dark_energy'(1), 'radiation'(2), and 'curvature'(3) </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -1081,7 +1081,7 @@ <h2 class="groupheader">Function Documentation</h2>
   <table class="params">
     <tr><td class="paramname">cosmo</td><td>Cosmological parameters </td></tr>
     <tr><td class="paramname">chi</td><td>Comoving distance in Mpc </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -1136,7 +1136,7 @@ <h2 class="groupheader">Function Documentation</h2>
     <tr><td class="paramname">nchi</td><td>Number of chis in chi </td></tr>
     <tr><td class="paramname">chi</td><td>array of comoving distances </td></tr>
     <tr><td class="paramname">output</td><td>array of length na to store the results of the calculation. The entry at index i stores the scale factor for chi[i]. </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>
@@ -1177,7 +1177,7 @@ <h2 class="groupheader">Function Documentation</h2>
   <table class="params">
     <tr><td class="paramname">cosmo</td><td>Cosmological parameters </td></tr>
     <tr><td class="paramname">chi</td><td>Comoving radial distance of two objects </td></tr>
-    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for ccl_error. </td></tr>
+    <tr><td class="paramname">status</td><td>Status flag. 0 if there are no errors, nonzero otherwise. For specific cases see documentation for <a class="el" href="ccl__error_8c.html">ccl_error.c</a> </td></tr>
   </table>
   </dd>
 </dl>