Skip to content

Commit

Permalink
deploy: a21bba6
Browse files Browse the repository at this point in the history
  • Loading branch information
visr committed Sep 15, 2024
1 parent d5acfb4 commit d4bb37d
Show file tree
Hide file tree
Showing 12 changed files with 167 additions and 167 deletions.
2 changes: 1 addition & 1 deletion cloudstorage.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="generator" content="quarto-1.5.57">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="generator" content="quarto-1.5.57">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down
68 changes: 34 additions & 34 deletions reference/CloudStorage.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="generator" content="quarto-1.5.57">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down Expand Up @@ -186,23 +186,23 @@ <h1>CloudStorage</h1>
<p>Connect a local ’data_dir` to cloud-storage.</p>
<section id="attributes" class="level2">
<h2 class="anchored" data-anchor-id="attributes">Attributes</h2>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.auth">auth</a></td>
<td>Auth tuple for requests</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.source_data">source_data</a></td>
<td>List of all source_data (directories) in sub-folder ’Basisgegevens`.</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.water_authorities">water_authorities</a></td>
<td>List of all water authorities (directories)</td>
</tr>
Expand All @@ -211,55 +211,55 @@ <h2 class="anchored" data-anchor-id="attributes">Attributes</h2>
</section>
<section id="methods" class="level2">
<h2 class="anchored" data-anchor-id="methods">Methods</h2>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.content">content</a></td>
<td>List all content in a directory</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.dirs">dirs</a></td>
<td>List sub-directories in a directory</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.download_aangeleverd">download_aangeleverd</a></td>
<td>Download all files in folder ‘aangeleverd’</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.download_all">download_all</a></td>
<td>Download all files for authority.</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.download_basisgegevens">download_basisgegevens</a></td>
<td>Download sources in the folder ‘Basisgegevens’</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.download_content">download_content</a></td>
<td>Download content of a directory recursively.</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.download_verwerkt">download_verwerkt</a></td>
<td>Download all files in folder ‘verwerkt’</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.upload_content">upload_content</a></td>
<td>Upload content of a directory recursively.</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.upload_model">upload_model</a></td>
<td>Upload a model to a water authority</td>
</tr>
<tr>
<tr class="even">
<td><a href="#ribasim_nl.CloudStorage.upload_verwerkt">upload_verwerkt</a></td>
<td>Upload all files in folder ‘verwerkt’</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#ribasim_nl.CloudStorage.uploaded_models">uploaded_models</a></td>
<td>Get all model versions uploaded for an authority</td>
</tr>
Expand All @@ -280,15 +280,15 @@ <h4 class="anchored" data-anchor-id="examples">Examples</h4>
</section>
<section id="returns" class="level4">
<h4 class="anchored" data-anchor-id="returns">Returns</h4>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td>list[str]</td>
<td>List of all content directories in a specified path</td>
</tr>
Expand All @@ -311,15 +311,15 @@ <h4 class="anchored" data-anchor-id="examples-1">Examples</h4>
</section>
<section id="returns-1" class="level4">
<h4 class="anchored" data-anchor-id="returns-1">Returns</h4>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td>list[str]</td>
<td>List of directories in a specified path</td>
</tr>
Expand Down Expand Up @@ -363,41 +363,41 @@ <h3 class="anchored" data-anchor-id="ribasim_nl.CloudStorage.upload_model">uploa
<p>Upload a model to a water authority</p>
<section id="parameters" class="level4">
<h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
<table class="caption-top">
<table class="caption-top table">
<colgroup>
<col style="width: 16%">
<col style="width: 7%">
<col style="width: 65%">
<col style="width: 10%">
</colgroup>
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><code>authority</code></td>
<td>str</td>
<td>Water authority to upload a model for</td>
<td><em>required</em></td>
</tr>
<tr>
<tr class="even">
<td><code>model</code></td>
<td>str</td>
<td>name of the model (directory) to upload</td>
<td><em>required</em></td>
</tr>
<tr>
<tr class="odd">
<td><code>include_results</code></td>
<td></td>
<td>to include results dir in upload; yes/no = True/False. defaults to False.</td>
<td><code>False</code></td>
</tr>
<tr>
<tr class="even">
<td><code>include_plots</code></td>
<td></td>
<td>to include plots dir in upload; yes/no = True/False. defaults to False.</td>
Expand All @@ -408,15 +408,15 @@ <h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
</section>
<section id="raises" class="level4">
<h4 class="anchored" data-anchor-id="raises">Raises</h4>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td>ValueError</td>
<td>If model does not exist locally</td>
</tr>
Expand Down
46 changes: 23 additions & 23 deletions reference/ExtendedGeoDataFrame.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>

<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.55">
<meta name="generator" content="quarto-1.5.57">

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

Expand Down Expand Up @@ -143,23 +143,23 @@ <h1>ExtendedGeoDataFrame</h1>
<p>A GeoPandas GeoDataFrame with extended properties and methods.</p>
<section id="methods" class="level2">
<h2 class="anchored" data-anchor-id="methods">Methods</h2>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><a href="#hydamo.ExtendedGeoDataFrame.delete_all">delete_all</a></td>
<td>Empty the dataframe</td>
</tr>
<tr>
<tr class="even">
<td><a href="#hydamo.ExtendedGeoDataFrame.set_data">set_data</a></td>
<td>Set data to the ExtendedGeoDataFrame.</td>
</tr>
<tr>
<tr class="odd">
<td><a href="#hydamo.ExtendedGeoDataFrame.snap_to_branch">snap_to_branch</a></td>
<td>Snap the geometries to the branch.</td>
</tr>
Expand All @@ -176,41 +176,41 @@ <h3 class="anchored" data-anchor-id="hydamo.ExtendedGeoDataFrame.set_data">set_d
<p>Set data to the ExtendedGeoDataFrame.</p>
<section id="parameters" class="level4">
<h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
<table class="caption-top">
<table class="caption-top table">
<colgroup>
<col style="width: 13%">
<col style="width: 10%">
<col style="width: 66%">
<col style="width: 9%">
</colgroup>
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><code>gdf</code></td>
<td>GeoDataFrame</td>
<td>GeoDataFrame with a HyDAMO object-layer</td>
<td><em>required</em></td>
</tr>
<tr>
<tr class="even">
<td><code>index_col</code></td>
<td>str</td>
<td>Column to be used as index. The default is None.</td>
<td><code>None</code></td>
</tr>
<tr>
<tr class="odd">
<td><code>check_columns</code></td>
<td>bool</td>
<td>Check if all required columns are present in the GeoDataFrame. The default is True.</td>
<td><code>True</code></td>
</tr>
<tr>
<tr class="even">
<td><code>check_geotype</code></td>
<td>bool</td>
<td>Check if the geometry is of the required type. The default is True.</td>
Expand All @@ -221,15 +221,15 @@ <h4 class="anchored" data-anchor-id="parameters">Parameters</h4>
</section>
<section id="returns" class="level4">
<h4 class="anchored" data-anchor-id="returns">Returns</h4>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td>None.</td>
<td></td>
</tr>
Expand All @@ -243,35 +243,35 @@ <h3 class="anchored" data-anchor-id="hydamo.ExtendedGeoDataFrame.snap_to_branch"
<p>Snap the geometries to the branch.</p>
<section id="parameters-1" class="level4">
<h4 class="anchored" data-anchor-id="parameters-1">Parameters</h4>
<table class="caption-top">
<table class="caption-top table">
<colgroup>
<col style="width: 15%">
<col style="width: 14%">
<col style="width: 56%">
<col style="width: 12%">
</colgroup>
<thead>
<tr>
<tr class="header">
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td><code>branches</code></td>
<td>GeoDataFrame</td>
<td>GeoDataFrame with branches</td>
<td><em>required</em></td>
</tr>
<tr>
<tr class="even">
<td><code>snap_method</code></td>
<td>str</td>
<td>Options for snapping</td>
<td><em>required</em></td>
</tr>
<tr>
<tr class="odd">
<td><code>maxdist</code></td>
<td>float</td>
<td>The maximal distance for snapping. The default is 5.</td>
Expand All @@ -282,15 +282,15 @@ <h4 class="anchored" data-anchor-id="parameters-1">Parameters</h4>
</section>
<section id="returns-1" class="level4">
<h4 class="anchored" data-anchor-id="returns-1">Returns</h4>
<table class="caption-top">
<table class="caption-top table">
<thead>
<tr>
<tr class="header">
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<tr class="odd">
<td>None.</td>
<td></td>
</tr>
Expand Down
Loading

0 comments on commit d4bb37d

Please sign in to comment.