Skip to content

Commit

Permalink
Built site for gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Quarto GHA Workflow Runner committed Oct 10, 2024
1 parent 559d790 commit e31bc3d
Show file tree
Hide file tree
Showing 25 changed files with 679 additions and 956 deletions.
2 changes: 1 addition & 1 deletion .nojekyll
Original file line number Diff line number Diff line change
@@ -1 +1 @@
9bc63c72
48e9e6cb
2 changes: 1 addition & 1 deletion R/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion R/misc/Identifying_Runs.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion README.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="./docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/datasets.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/docker-configurations.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/pipeline_guidance.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down Expand Up @@ -397,7 +397,7 @@ <h3 data-number="1.2" class="anchored" data-anchor-id="setting-up-your-python-en
```xdkixn
```lxkmtj
#| eval: false
conda install -c conda-forge gdal
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/clim_recal.ceda_ftp_download.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
41 changes: 18 additions & 23 deletions docs/reference/clim_recal.config.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down Expand Up @@ -364,7 +364,7 @@ <h2 data-number="1.1" class="anchored" data-anchor-id="classes"><span class="hea
</table>
<section id="python.clim_recal.config.ClimRecalConfig" class="level3" data-number="1.1.1">
<h3 data-number="1.1.1" class="anchored" data-anchor-id="python.clim_recal.config.ClimRecalConfig"><span class="header-section-number">1.1.1</span> ClimRecalConfig</h3>
<p><code>clim_recal.config.ClimRecalConfig(self, command_dir=COMMAND_DIR_DEFAULT, run_prefix=RUN_PREFIX_DEFAULT, preprocess_data_file=PREPROCESS_FILE_NAME, run_cmethods_file=CMETHODS_FILE_NAME, data_path=DATA_PATH_DEFAULT, mod_folder=MOD_FOLDER_DEFAULT, obs_folder=OBS_FOLDER_DEFAULT, preprocess_out_folder=PREPROCESS_OUT_FOLDER_DEFAULT, cmethods_out_folder=CMETHODS_OUT_FOLDER_DEFAULT, calib_date_start=CALIB_DATE_START_DEFAULT, calib_date_end=CALIB_DATE_END_DEFAULT, valid_date_start=VALID_DATE_START_DEFAULT, valid_date_end=VALID_DATE_END_DEFAULT, processors=PROCESSORS_DEFAULT, date_format_str=CLI_DATE_FORMAT_STR, date_split_str=DATE_FORMAT_SPLIT_STR, variables=(VariableOptions.default()), runs=(RunOptions.default()), regions=(RegionOptions.default()), methods=(MethodOptions.default()), multiprocess=False, cpus=DEFAULT_CPUS, hads_input_path=RAW_HADS_PATH, cpm_input_path=RAW_CPM_PATH, output_path=DEFAULT_OUTPUT_PATH, convert_folder=DEFAULT_CONVERT_FOLDER, crops_folder=DEFAULT_CROPS_FOLDER, hads_output_folder=HADS_OUTPUT_PATH, cpm_output_folder=CPM_OUTPUT_PATH, cpm_kwargs=dict(), hads_kwargs=dict(), cpm_crop_kwargs=dict(), hads_crop_kwargs=dict(), convert_start_index=0, convert_stop_index=None, crop_start_index=0, crop_stop_index=None, add_local_dated_results_path=True, add_local_dated_crops_path=True, local_dated_results_path_prefix='run', local_dated_crops_path_prefix='crop', cpm_for_coord_alignment=None, process_cmp_for_coord_alignment=False, cpm_for_coord_alignment_path_converted=False, debug_mode=False)</code></p>
<p><code>clim_recal.config.ClimRecalConfig(self, command_dir=COMMAND_DIR_DEFAULT, run_prefix=RUN_PREFIX_DEFAULT, preprocess_data_file=PREPROCESS_FILE_NAME, run_cmethods_file=CMETHODS_FILE_NAME, data_path=DATA_PATH_DEFAULT, mod_folder=MOD_FOLDER_DEFAULT, obs_folder=OBS_FOLDER_DEFAULT, preprocess_out_folder=PREPROCESS_OUT_FOLDER_DEFAULT, cmethods_out_folder=CMETHODS_OUT_FOLDER_DEFAULT, calib_date_start=CALIB_DATE_START_DEFAULT, calib_date_end=CALIB_DATE_END_DEFAULT, valid_date_start=VALID_DATE_START_DEFAULT, valid_date_end=VALID_DATE_END_DEFAULT, processors=PROCESSORS_DEFAULT, date_format_str=CLI_DATE_FORMAT_STR, date_split_str=DATE_FORMAT_SPLIT_STR, variables=(VariableOptions.default()), runs=(RunOptions.default()), regions=(RegionOptions.default()), methods=(MethodOptions.default()), multiprocess=False, cpus=DEFAULT_CPUS, hads_input_path=RAW_HADS_PATH, cpm_input_path=RAW_CPM_PATH, output_path=DEFAULT_OUTPUT_PATH, resample_folder=DEFAULT_RESAMPLE_FOLDER, crops_folder=DEFAULT_CROPS_FOLDER, hads_output_folder=HADS_OUTPUT_LOCAL_PATH, cpm_output_folder=CPM_OUTPUT_LOCAL_PATH, cpm_kwargs=dict(), hads_kwargs=dict(), start_index=0, stop_index=None, add_local_dated_results_path=True, add_local_dated_crops_path=True, local_dated_results_path_prefix='run', local_dated_crops_path_prefix='crop', cpm_for_coord_alignment=None, process_cmp_for_coord_alignment=False, cpm_for_coord_alignment_path_converted=False, debug_mode=False)</code></p>
<p>Manage creating command line scripts to run <code>debiasing</code> <code>cli</code>.</p>
<section id="attributes" class="level4" data-number="1.1.1.1">
<h4 data-number="1.1.1.1" class="anchored" data-anchor-id="attributes"><span class="header-section-number">1.1.1.1</span> Attributes</h4>
Expand Down Expand Up @@ -418,34 +418,34 @@ <h4 data-number="1.1.1.1" class="anchored" data-anchor-id="attributes"><span cla
<td><code>Path</code> to save all intermediate and final results to.</td>
</tr>
<tr class="even">
<td>convert_folder</td>
<td>resample_folder</td>
<td>PathLike</td>
<td><code>Path</code> to append to <code>output_path</code> for resampling result files.</td>
</tr>
<tr class="odd">
<td>crops_folder</td>
<td>PathLike</td>
<td><code>Path</code> to append to <code>output_path</code> for cropped convert files.</td>
<td><code>Path</code> to append to <code>output_path</code> for cropped resample files.</td>
</tr>
<tr class="even">
<td>hads_output_folder</td>
<td>PathLike</td>
<td><code>Path</code> to append to <code>output_path</code> / <code>convert_folder</code> for resampling <code>HADs</code> files and to <code>output_path</code> / <code>crop_folder</code> for crops.</td>
<td><code>Path</code> to append to <code>output_path</code> / <code>resample_folder</code> for resampling <code>HADs</code> files and to <code>output_path</code> / <code>crop_folder</code> for crops.</td>
</tr>
<tr class="odd">
<td>cpm_output_folder</td>
<td>PathLike</td>
<td><code>Path</code> to append to <code>output_path</code> / <code>convert_folder</code> for resampling <code>CPM</code> files and to <code>output_path</code> / <code>crop_folder</code> for crops.</td>
<td><code>Path</code> to append to <code>output_path</code> / <code>resample_folder</code> for resampling <code>CPM</code> files and to <code>output_path</code> / <code>crop_folder</code> for crops.</td>
</tr>
<tr class="even">
<td>cpm_kwargs</td>
<td>dict</td>
<td>A <code>dict</code> of parameters to pass to a <code>CPMConvertManager</code>.</td>
<td>A <code>dict</code> of parameters to pass to a <code>CPMResamplerManager</code>.</td>
</tr>
<tr class="odd">
<td>hads_kwargs</td>
<td>dict</td>
<td>A <code>dict</code> of parameters to pass to <code>HADsConvertManager</code>.</td>
<td>A <code>dict</code> of parameters to pass to <code>HADsResamplerManager</code>.</td>
</tr>
<tr class="even">
<td>cpm_for_coord_alignment</td>
Expand All @@ -468,14 +468,11 @@ <h4 data-number="1.1.1.2" class="anchored" data-anchor-id="examples"><span class
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a>... regions<span class="op">=</span>(<span class="st">'Manchester'</span>, <span class="st">'Glasgow'</span>),</span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a>... output_path<span class="op">=</span>test_runs_output_path,</span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a>... cpus<span class="op">=</span><span class="dv">1</span>)</span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="co">'set_cpm_for_coord_alignment'</span> <span class="cf">for</span> <span class="st">'HADs'</span> <span class="kw">not</span> speficied.</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a>Defaulting to <span class="st">'self.cpm_input_path'</span>: <span class="st">'.../ClimateData/Raw/UKCP2.2'</span></span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> run_config</span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="op">&lt;</span>ClimRecalConfig(variables_count<span class="op">=</span><span class="dv">1</span>, runs_count<span class="op">=</span><span class="dv">1</span>, regions_count<span class="op">=</span><span class="dv">2</span>,</span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a> methods_count<span class="op">=</span><span class="dv">1</span>, cpm_folders_count<span class="op">=</span><span class="dv">1</span>,</span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a> hads_folders_count<span class="op">=</span><span class="dv">1</span>, convert_start_index<span class="op">=</span><span class="dv">0</span>,</span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a> convert_stop_index<span class="op">=</span><span class="va">None</span>, crop_start_index<span class="op">=</span><span class="dv">0</span>,</span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a> crop_stop_index<span class="op">=</span><span class="va">None</span>, cpus<span class="op">=</span><span class="dv">1</span>)<span class="op">&gt;</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> run_config</span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a><span class="op">&lt;</span>ClimRecalConfig(variables_count<span class="op">=</span><span class="dv">1</span>, runs_count<span class="op">=</span><span class="dv">1</span>, regions_count<span class="op">=</span><span class="dv">2</span>,</span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a> methods_count<span class="op">=</span><span class="dv">1</span>, cpm_folders_count<span class="op">=</span><span class="dv">1</span>,</span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a> hads_folders_count<span class="op">=</span><span class="dv">1</span>, start_index<span class="op">=</span><span class="dv">0</span>,</span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a> stop_index<span class="op">=</span><span class="va">None</span>, cpus<span class="op">=</span><span class="dv">1</span>)<span class="op">&gt;</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="methods" class="level4" data-number="1.1.1.3">
<h4 data-number="1.1.1.3" class="anchored" data-anchor-id="methods"><span class="header-section-number">1.1.1.3</span> Methods</h4>
Expand Down Expand Up @@ -504,19 +501,17 @@ <h5 data-number="1.1.1.3.1" class="anchored" data-anchor-id="python.clim_recal.c
<section id="examples-1" class="level6" data-number="1.1.1.3.1.1">
<h6 data-number="1.1.1.3.1.1" class="anchored" data-anchor-id="examples-1"><span class="header-section-number">1.1.1.3.1.1</span> Examples</h6>
<div class="sourceCode" id="cb2"><pre class="sourceCode python code-with-copy"><code class="sourceCode python"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> clim_runner: ClimRecalConfig <span class="op">=</span> getfixture(<span class="st">'clim_runner'</span>)</span>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="co">'set_cpm_for_coord_alignment'</span> <span class="cf">for</span> <span class="st">'HADs'</span> <span class="kw">not</span> speficied.</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a>Defaulting to <span class="st">'self.cpm_input_path'</span>: <span class="st">'...'</span></span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> runs: <span class="bu">dict</span>[<span class="bu">tuple</span>, <span class="bu">dict</span>] <span class="op">=</span> clim_runner.run_models()</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> pprint(<span class="bu">tuple</span>(runs.keys()))</span>
<span id="cb2-6"><a href="#cb2-6" aria-hidden="true" tabindex="-1"></a>((<span class="st">'Glasgow'</span>, <span class="st">'tasmax'</span>, <span class="st">'05'</span>, <span class="st">'quantile_delta_mapping'</span>),</span>
<span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> (<span class="st">'Manchester'</span>, <span class="st">'tasmax'</span>, <span class="st">'05'</span>, <span class="st">'quantile_delta_mapping'</span>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> runs: <span class="bu">dict</span>[<span class="bu">tuple</span>, <span class="bu">dict</span>] <span class="op">=</span> clim_runner.run_models()</span>
<span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a><span class="op">&gt;&gt;&gt;</span> pprint(<span class="bu">tuple</span>(runs.keys()))</span>
<span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a>((<span class="st">'Glasgow'</span>, <span class="st">'tasmax'</span>, <span class="st">'05'</span>, <span class="st">'quantile_delta_mapping'</span>),</span>
<span id="cb2-5"><a href="#cb2-5" aria-hidden="true" tabindex="-1"></a> (<span class="st">'Manchester'</span>, <span class="st">'tasmax'</span>, <span class="st">'05'</span>, <span class="st">'quantile_delta_mapping'</span>))</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
</section>
<section id="python.clim_recal.config.ClimRecalConfig.set_cpm_for_coord_alignment" class="level5" data-number="1.1.1.3.2">
<h5 data-number="1.1.1.3.2" class="anchored" data-anchor-id="python.clim_recal.config.ClimRecalConfig.set_cpm_for_coord_alignment"><span class="header-section-number">1.1.1.3.2</span> set_cpm_for_coord_alignment</h5>
<p><code>clim_recal.config.ClimRecalConfig.set_cpm_for_coord_alignment()</code></p>
<p>If <code>cpm_for_coord_alignment</code> is <code>None</code> use <code>self.cpm_input_path</code>.</p>
<p>It would be more efficient to use <code>self.convert_cpm_path</code> as long as that option is used, but support cases of only</p>
<p>It would be more efficient to use <code>self.resample_cpm_path</code> as long as that option is used, but support cases of only</p>
</section>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/clim_recal.data_loader.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/clim_recal.debiasing.debias_wrapper.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="../../docs/reference/clim_recal.convert.html" class="sidebar-item-text sidebar-link">
<a href="../../docs/reference/clim_recal.resample.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Data Resampling</span></a>
</div>
</li>
Expand Down
Loading

0 comments on commit e31bc3d

Please sign in to comment.