added documentation to ACP

Author: vargatn

doc/build/doctrees/api.doctree

@@ -142,6 +142,7 @@
   <h1>All modules for which code is available</h1>
 <ul><li><a href="xpipe/tools/catalogs.html">xpipe.tools.catalogs</a></li>
 <li><a href="xpipe/tools/selector.html">xpipe.tools.selector</a></li>
+<li><a href="xpipe/tools/y3_sompz.html">xpipe.tools.y3_sompz</a></li>
 <li><a href="xpipe/xhandle/ioshear.html">xpipe.xhandle.ioshear</a></li>
 <li><a href="xpipe/xhandle/parbins.html">xpipe.xhandle.parbins</a></li>
 <li><a href="xpipe/xhandle/pzboost.html">xpipe.xhandle.pzboost</a></li>

doc/build/doctrees/environment.pickle

@@ -5,6 +5,32 @@ API Reference
 =============
 
 
+DES Y3 wrappers
+---------------
+
+SOMPZ
+"""""
+
+.. autosummary::
+    :toctree: generated
+
+    xpipe.tools.y3_sompz.sigma_crit_inv
+
+.. autosummary::
+    :toctree: generated
+    :template: custom.rst
+
+    xpipe.tools.y3_sompz.sompz_reader
+
+Combine shear profiles and apply calibrations
+"""""""""""""""""""""""""""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :template: custom.rst
+
+    xpipe.xhandle.shearops.AutoCalibrateProfile
+
+
 Input file manipulation
 -----------------------
 
@@ -314,6 +340,9 @@ tools.selector
     xpipe.tools.selector.safedivide
 
 
+# TODO
+Visualization
+
 example function
 """"""""""""""""
 

doc/build/html/_modules/index.html

@@ -21,7 +21,7 @@
 
   <link rel="index" title="Index" href="genindex.html" />
   <link rel="search" title="Search" href="search.html" />
-  <link rel="next" title="xpipe.xhandle.parbins.XIO" href="generated/xpipe.xhandle.parbins.XIO.html" />
+  <link rel="next" title="xpipe.tools.y3_sompz.sigma_crit_inv" href="generated/xpipe.tools.y3_sompz.sigma_crit_inv.html" />
   <link rel="prev" title="Config files explained" href="config.html" /> 
   </head>
 
@@ -117,6 +117,8 @@
 
               <ul>
 
+                  <li class="toctree-l2"><a href="#des-y3-wrappers" class="reference internal">DES Y3 wrappers</a></li>
+                
                   <li class="toctree-l2"><a href="#input-file-manipulation" class="reference internal">Input file manipulation</a></li>
 
                   <li class="toctree-l2"><a href="#xshear-wrapper" class="reference internal">XSHEAR wrapper</a></li>
@@ -154,8 +156,8 @@
        title="previous chapter">← Config files explained</a>
   </li>
   <li class="next">
-    <a href="generated/xpipe.xhandle.parbins.XIO.html"
-       title="next chapter">xpipe.xhandle.parbins.XIO →</a>
+    <a href="generated/xpipe.tools.y3_sompz.sigma_crit_inv.html"
+       title="next chapter">xpipe.tools.y3_sompz.sigma_crit_inv →</a>
   </li>
 </ul>
 
@@ -165,6 +167,48 @@
 
   <div class="section" id="api-reference">
 <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="des-y3-wrappers">
+<h2>DES Y3 wrappers<a class="headerlink" href="#des-y3-wrappers" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="sompz">
+<h3>SOMPZ<a class="headerlink" href="#sompz" title="Permalink to this headline">¶</a></h3>
+<table class="autosummary longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/xpipe.tools.y3_sompz.sigma_crit_inv.html#xpipe.tools.y3_sompz.sigma_crit_inv" title="xpipe.tools.y3_sompz.sigma_crit_inv"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xpipe.tools.y3_sompz.sigma_crit_inv</span></code></a>(zclust, z)</p></td>
+<td><p>Calculates sigma crit inverse</p></td>
+</tr>
+</tbody>
+</table>
+<table class="autosummary longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/xpipe.tools.y3_sompz.sompz_reader.html#xpipe.tools.y3_sompz.sompz_reader" title="xpipe.tools.y3_sompz.sompz_reader"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xpipe.tools.y3_sompz.sompz_reader</span></code></a>(main_file_path)</p></td>
+<td><p>Reader class for DES Y3 - style SOMPZ data</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="section" id="combine-shear-profiles-and-apply-calibrations">
+<h3>Combine shear profiles and apply calibrations<a class="headerlink" href="#combine-shear-profiles-and-apply-calibrations" title="Permalink to this headline">¶</a></h3>
+<table class="autosummary longtable docutils align-default">
+<colgroup>
+<col style="width: 10%" />
+<col style="width: 90%" />
+</colgroup>
+<tbody>
+<tr class="row-odd"><td><p><a class="reference internal" href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile" title="xpipe.xhandle.shearops.AutoCalibrateProfile"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xpipe.xhandle.shearops.AutoCalibrateProfile</span></code></a>(...)</p></td>
+<td><p>WEIGHTS must be from the base input dataset for Random points!!!</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
 <div class="section" id="input-file-manipulation">
 <h2>Input file manipulation<a class="headerlink" href="#input-file-manipulation" title="Permalink to this headline">¶</a></h2>
 <p>The bulk of the action is performed by the main writer class:</p>
@@ -663,6 +707,8 @@ <h3>tools.catalogs<a class="headerlink" href="#tools-catalogs" title="Permalink
 </tr>
 </tbody>
 </table>
+<p># TODO
+Visualization</p>
 </div>
 <div class="section" id="example-function">
 <h3>example function<a class="headerlink" href="#example-function" title="Permalink to this headline">¶</a></h3>
@@ -690,8 +736,8 @@ <h3>example function<a class="headerlink" href="#example-function" title="Permal
        title="previous chapter">← Config files explained</a>
   </li>
   <li class="next">
-    <a href="generated/xpipe.xhandle.parbins.XIO.html"
-       title="next chapter">xpipe.xhandle.parbins.XIO →</a>
+    <a href="generated/xpipe.tools.y3_sompz.sigma_crit_inv.html"
+       title="next chapter">xpipe.tools.y3_sompz.sigma_crit_inv →</a>
   </li>
 </ul><div class="footer" role="contentinfo">
       &#169; Copyright 2022, Tamas Norbert Varga.

doc/build/html/_sources/api.rst.txt

@@ -165,13 +165,19 @@ <h1 id="index">Index</h1>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.add_boost">add_boost() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.add_boost_jk">add_boost_jk() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
+</li>
       <li><a href="generated/xpipe.xhandle.xwrap.addlines.html#xpipe.xhandle.xwrap.addlines">addlines() (in module xpipe.xhandle.xwrap)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.parbins.assign_jk_labels.html#xpipe.xhandle.parbins.assign_jk_labels">assign_jk_labels() (in module xpipe.xhandle.parbins)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.parbins.assign_kmeans_labels.html#xpipe.xhandle.parbins.assign_kmeans_labels">assign_kmeans_labels() (in module xpipe.xhandle.parbins)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile">AutoCalibrateProfile (class in xpipe.xhandle.shearops)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -181,11 +187,13 @@ <h2 id="B">B</h2>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.balance_infodicts.html#xpipe.xhandle.pzboost.balance_infodicts">balance_infodicts() (in module xpipe.xhandle.pzboost)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.BoostMixer.html#xpipe.xhandle.pzboost.BoostMixer">BoostMixer (class in xpipe.xhandle.pzboost)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.BoostMixerRandRef.html#xpipe.xhandle.pzboost.BoostMixerRandRef">BoostMixerRandRef (class in xpipe.xhandle.pzboost)</a>
+</li>
+      <li><a href="generated/xpipe.tools.y3_sompz.sompz_reader.html#xpipe.tools.y3_sompz.sompz_reader.build_lookup">build_lookup() (xpipe.tools.y3_sompz.sompz_reader method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -203,15 +211,23 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.CatRotator.html#xpipe.xhandle.xwrap.CatRotator">CatRotator (class in xpipe.xhandle.xwrap)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.check_pwsum_files.html#xpipe.xhandle.pzboost.check_pwsum_files">check_pwsum_files() (in module xpipe.xhandle.pzboost)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.chunkwise_rotate.html#xpipe.xhandle.xwrap.chunkwise_rotate">chunkwise_rotate() (in module xpipe.xhandle.xwrap)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.combine_pwsums.html#xpipe.xhandle.pzboost.combine_pwsums">combine_pwsums() (in module xpipe.xhandle.pzboost)</a>
 </li>
-      <li><a href="generated/xpipe.xhandle.shearops.StackedProfileContainer.html#xpipe.xhandle.shearops.StackedProfileContainer.composite">composite() (xpipe.xhandle.shearops.StackedProfileContainer method)</a>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.combine_sbins">combine_sbins() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.composite">composite() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
+
+      <ul>
+        <li><a href="generated/xpipe.xhandle.shearops.StackedProfileContainer.html#xpipe.xhandle.shearops.StackedProfileContainer.composite">(xpipe.xhandle.shearops.StackedProfileContainer method)</a>
+</li>
+      </ul></li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.copy">copy() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.create_infodict.html#xpipe.xhandle.xwrap.create_infodict">create_infodict() (in module xpipe.xhandle.xwrap)</a>
 </li>
@@ -268,6 +284,8 @@ <h2 id="G">G</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.gauss.html#xpipe.xhandle.pzboost.gauss">gauss() (in module xpipe.xhandle.pzboost)</a>
+</li>
+      <li><a href="generated/xpipe.tools.y3_sompz.sompz_reader.html#xpipe.tools.y3_sompz.sompz_reader.get_bin_scinv">get_bin_scinv() (xpipe.tools.y3_sompz.sompz_reader method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.parbins.get_fields_auto.html#xpipe.xhandle.parbins.get_fields_auto">get_fields_auto() (in module xpipe.xhandle.parbins)</a>
 </li>
@@ -283,23 +301,31 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.get_main_source_settings_nopairs.html#xpipe.xhandle.xwrap.get_main_source_settings_nopairs">get_main_source_settings_nopairs() (in module xpipe.xhandle.xwrap)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.pzboost.PDFContainer.html#xpipe.xhandle.pzboost.PDFContainer.get_mean_pdfs">get_mean_pdfs() (xpipe.xhandle.pzboost.PDFContainer method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.xwrap.get_metanames.html#xpipe.xhandle.xwrap.get_metanames">get_metanames() (in module xpipe.xhandle.xwrap)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.pzboost.PDFContainer.html#xpipe.xhandle.pzboost.PDFContainer.get_nsources">get_nsources() (xpipe.xhandle.pzboost.PDFContainer method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.CatRotator.html#xpipe.xhandle.xwrap.CatRotator.get_oname">get_oname() (xpipe.xhandle.xwrap.CatRotator method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.get_pairlog.html#xpipe.xhandle.xwrap.get_pairlog">get_pairlog() (in module xpipe.xhandle.xwrap)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.get_profiles">get_profiles() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.get_redges.html#xpipe.xhandle.xwrap.get_redges">get_redges() (in module xpipe.xhandle.xwrap)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.get_rot_seeds.html#xpipe.xhandle.xwrap.get_rot_seeds">get_rot_seeds() (in module xpipe.xhandle.xwrap)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.get_scinvs">get_scinvs() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.get_scinvs_bin">get_scinvs_bin() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.get_shear.html#xpipe.xhandle.xwrap.get_shear">get_shear() (in module xpipe.xhandle.xwrap)</a>
+</li>
+      <li><a href="generated/xpipe.tools.y3_sompz.sompz_reader.html#xpipe.tools.y3_sompz.sompz_reader.get_single_scinv">get_single_scinv() (xpipe.tools.y3_sompz.sompz_reader method)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -308,10 +334,14 @@ <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.parbins.load_lenscat.html#xpipe.xhandle.parbins.load_lenscat">load_lenscat() (in module xpipe.xhandle.parbins)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.load_profiles">load_profiles() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.xhandle.parbins.load_randcat.html#xpipe.xhandle.parbins.load_randcat">load_randcat() (in module xpipe.xhandle.parbins)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.load_targets">load_targets() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.parbins.XIO.html#xpipe.xhandle.parbins.XIO.loop_bins">loop_bins() (xpipe.xhandle.parbins.XIO method)</a>
 </li>
@@ -435,6 +465,8 @@ <h2 id="S">S</h2>
       <li><a href="generated/xpipe.xhandle.parbins.XIO.html#xpipe.xhandle.parbins.XIO.save_rands_jk">save_rands_jk() (xpipe.xhandle.parbins.XIO method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.parbins.XIO.html#xpipe.xhandle.parbins.XIO.savelists">savelists() (xpipe.xhandle.parbins.XIO method)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.scale_cut">scale_cut() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -443,8 +475,12 @@ <h2 id="S">S</h2>
       <li><a href="generated/xpipe.xhandle.xwrap.serial_rotate.html#xpipe.xhandle.xwrap.serial_rotate">serial_rotate() (in module xpipe.xhandle.xwrap)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.parbins.XIO.html#xpipe.xhandle.parbins.XIO.setbin">setbin() (xpipe.xhandle.parbins.XIO method)</a>
+</li>
+      <li><a href="generated/xpipe.tools.y3_sompz.sigma_crit_inv.html#xpipe.tools.y3_sompz.sigma_crit_inv">sigma_crit_inv() (in module xpipe.tools.y3_sompz)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.xwrap.single_rotate.html#xpipe.xhandle.xwrap.single_rotate">single_rotate() (in module xpipe.xhandle.xwrap)</a>
+</li>
+      <li><a href="generated/xpipe.tools.y3_sompz.sompz_reader.html#xpipe.tools.y3_sompz.sompz_reader">sompz_reader (class in xpipe.tools.y3_sompz)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.shearops.stacked_pcov.html#xpipe.xhandle.shearops.stacked_pcov">stacked_pcov() (in module xpipe.xhandle.shearops)</a>
 </li>
@@ -467,6 +503,8 @@ <h2 id="T">T</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="generated/xpipe.tools.catalogs.to_pandas.html#xpipe.tools.catalogs.to_pandas">to_pandas() (in module xpipe.tools.catalogs)</a>
+</li>
+      <li><a href="generated/xpipe.xhandle.shearops.AutoCalibrateProfile.html#xpipe.xhandle.shearops.AutoCalibrateProfile.to_profile">to_profile() (xpipe.xhandle.shearops.AutoCalibrateProfile method)</a>
 </li>
       <li><a href="generated/xpipe.xhandle.shearops.StackedProfileContainer.html#xpipe.xhandle.shearops.StackedProfileContainer.to_sub_dict">to_sub_dict() (xpipe.xhandle.shearops.StackedProfileContainer method)</a>
 </li>

doc/build/html/api.html

@@ -178,6 +178,7 @@ <h1>Welcome to the XPIPE weak lensing toolset<a class="headerlink" href="#welcom
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="api.html">API reference</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="api.html#des-y3-wrappers">DES Y3 wrappers</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#input-file-manipulation">Input file manipulation</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#xshear-wrapper">XSHEAR wrapper</a></li>
 <li class="toctree-l2"><a class="reference internal" href="api.html#postprocessing-xshear-output">Postprocessing XSHEAR output</a></li>

doc/build/html/genindex.html

@@ -5,6 +5,32 @@ API Reference
 =============
 
 
+DES Y3 wrappers
+---------------
+
+SOMPZ
+"""""
+
+.. autosummary::
+    :toctree: generated
+
+    xpipe.tools.y3_sompz.sigma_crit_inv
+
+.. autosummary::
+    :toctree: generated
+    :template: custom.rst
+
+    xpipe.tools.y3_sompz.sompz_reader
+
+Combine shear profiles and apply calibrations
+"""""""""""""""""""""""""""""""""""""""""""""
+.. autosummary::
+    :toctree: generated
+    :template: custom.rst
+
+    xpipe.xhandle.shearops.AutoCalibrateProfile
+
+
 Input file manipulation
 -----------------------
 
@@ -314,6 +340,9 @@ tools.selector
     xpipe.tools.selector.safedivide
 
 
+# TODO
+Visualization
+
 example function
 """"""""""""""""