Deployed 1182810 with MkDocs version: 1.6.0

404.html

@@ -16,7 +16,7 @@
 
 
       <link rel="icon" href="/assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -189,7 +189,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2051,7 +2051,7 @@ <h1>404 - Not found</h1>
     <script id="__config" type="application/json">{"base": "/", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="/assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="/assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="/termynal.js"></script>
 

explanations/access_control/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2141,7 +2141,7 @@ <h1 id="access-control">Access Control<a class="headerlink" href="#access-contro
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>
 

explanations/benchmarking/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -358,6 +358,8 @@
 
 
 
+
+
               <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
@@ -1907,6 +1909,15 @@
     <nav class="md-nav" aria-label="Results">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#07022024-downloading-files-from-synapse" class="md-nav__link">
+    <span class="md-ellipsis">
+      07/02/2024: Downloading files from Synapse
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#05102024-uploading-files-to-synapse" class="md-nav__link">
     <span class="md-ellipsis">
@@ -2109,7 +2120,9 @@
 
 
 
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+
+
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
                 <div class="md-sidebar__scrollwrap">
                   <div class="md-sidebar__inner">
 
@@ -2137,6 +2150,15 @@
     <nav class="md-nav" aria-label="Results">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#07022024-downloading-files-from-synapse" class="md-nav__link">
+    <span class="md-ellipsis">
+      07/02/2024: Downloading files from Synapse
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#05102024-uploading-files-to-synapse" class="md-nav__link">
     <span class="md-ellipsis">
@@ -2250,11 +2272,101 @@ <h1 id="benchmarking">Benchmarking<a class="headerlink" href="#benchmarking" tit
 data driven decisions on where to spend time optimizing the client. Additionally, it
 will give us a way to measure the impact of changes to the client.</p>
 <h2 id="results">Results<a class="headerlink" href="#results" title="Permanent link">&para;</a></h2>
+<h3 id="07022024-downloading-files-from-synapse">07/02/2024: Downloading files from Synapse<a class="headerlink" href="#07022024-downloading-files-from-synapse" title="Permanent link">&para;</a></h3>
+<p>These benchmarking results were collected due to the following changes:</p>
+<ul>
+<li>The download algorithm for the client was re-written to focus on error handling and
+handling of multi-threaded downloads orchestrated by AsyncIO.</li>
+<li>The <code>synapseutils.syncFromSynapse()</code> function was refactored to use this new logic</li>
+</ul>
+<p>The results were created on a <code>t3a.micro</code> EC2 instance with a 200GB disk size running
+in us-east-1. The script that was run can be found in <code>docs/scripts/downloadBenchmark.py</code>.</p>
+<p>Average transfer time result:</p>
+<ul>
+<li>&lt;= 100 MiB per file: <p style="color:green;">8% Decrease</p></li>
+<li>&gt;= 1 GiB per file: <p style="color:green;">31% Decrease</p></li>
+</ul>
+<table>
+<thead>
+<tr>
+<th>Test</th>
+<th>Total Transfer Size</th>
+<th>v4.4.0 .syncFromSynapse()</th>
+<th>v4.3.0 .syncFromSynapse()</th>
+<th>v4.4.0 .Get()</th>
+<th>v4.3.0 .Get()</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>10 File/10GiB ea</td>
+<td>100GiB</td>
+<td>1910s <p style="color:green;">39% Decrease</p></td>
+<td>3155s</td>
+<td>2186s <p style="color:green;">26% Decrease</p></td>
+<td>2958s</td>
+</tr>
+<tr>
+<td>1 File/10GiB ea</td>
+<td>10GiB</td>
+<td>229s <p style="color:green;">21% Decrease</p></td>
+<td>289s</td>
+<td>214s <p style="color:green;">31% Decrease</p></td>
+<td>308s</td>
+</tr>
+<tr>
+<td>10 File/1GiB ea</td>
+<td>10GiB</td>
+<td>174s <p style="color:green;">47% Decrease</p></td>
+<td>330s</td>
+<td>224s <p style="color:green;">24% Decrease</p></td>
+<td>295s</td>
+</tr>
+<tr>
+<td>100 File/100 MiB ea</td>
+<td>10GiB</td>
+<td>161s <p style="color:red;">3% Increase</p></td>
+<td>156s</td>
+<td>228s <p style="color:green;">13% Decrease</p></td>
+<td>262s</td>
+</tr>
+<tr>
+<td>10 File/100 MiB ea</td>
+<td>1GiB</td>
+<td>15s <p style="color:green;">12% Decrease</p></td>
+<td>17s</td>
+<td>24s <p style="color:green;">11% Decrease</p></td>
+<td>27s</td>
+</tr>
+<tr>
+<td>100 File/10 MiB ea</td>
+<td>1GiB</td>
+<td>24s <p style="color:green;">14% Decrease</p></td>
+<td>28s</td>
+<td>69s <p style="color:green;">9% Decrease</p></td>
+<td>76s</td>
+</tr>
+<tr>
+<td>1000 File/1 MiB ea</td>
+<td>1GiB</td>
+<td>98s <p style="color:green;">8% Decrease</p></td>
+<td>106s</td>
+<td>309s <p style="color:green;">1% Decrease</p></td>
+<td>312s</td>
+</tr>
+</tbody>
+</table>
+<ul>
+<li><a class="autorefs autorefs-internal" href="../../reference/synapse_utils/#synapseutils.sync.syncFromSynapse">.syncFromSynapse() documentation</a></li>
+<li><a class="autorefs autorefs-internal" href="../../reference/client/#synapseclient.Synapse.get">.Get() documentation</a></li>
+</ul>
 <h3 id="05102024-uploading-files-to-synapse">05/10/2024: Uploading files to Synapse<a class="headerlink" href="#05102024-uploading-files-to-synapse" title="Permanent link">&para;</a></h3>
-<p>These benchmarking results were collected due to the following changes:
-- The upload algorithm for the Synapseutils <code>syncToSynapse</code> being re-written to take
-advantage of the new AsyncIO upload algorithm for individual files.
-- An updated limit on concurrent file transfers to match <code>max_threads * 2</code></p>
+<p>These benchmarking results were collected due to the following changes:</p>
+<ul>
+<li>The upload algorithm for the Synapseutils <code>syncToSynapse</code> being re-written to take
+advantage of the new AsyncIO upload algorithm for individual files.</li>
+<li>An updated limit on concurrent file transfers to match <code>max_threads * 2</code></li>
+</ul>
 <table>
 <thead>
 <tr>
@@ -2668,10 +2780,15 @@ <h3 id="11142023-uploading-files-to-synapse-default-thread-count">11/14/2023: Up
 
 
 
+
+
 
 
 
 
+
+
+
 
 
               </article>
@@ -2687,6 +2804,8 @@ <h3 id="11142023-uploading-files-to-synapse-default-thread-count">11/14/2023: Up
 
 
 
+
+
       <nav class="md-footer__inner md-grid" aria-label="Footer" >
 
 
@@ -2787,7 +2906,7 @@ <h3 id="11142023-uploading-files-to-synapse-default-thread-count">11/14/2023: Up
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>
 

explanations/domain_models_of_synapse/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2334,7 +2334,7 @@ <h2 id="activityprovenance"><a href="../../tutorials/python/activity/">Activity/
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>
 

explanations/home/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2137,7 +2137,7 @@ <h1 id="further-reading">Further Reading<a class="headerlink" href="#further-rea
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>
 

explanations/manifest_tsv/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2648,7 +2648,7 @@ <h2 id="refernces">Refernces:<a class="headerlink" href="#refernces" title="Perm
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>
 

explanations/properties_vs_annotations/index.html

@@ -20,7 +20,7 @@
 
 
       <link rel="icon" href="../../assets/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.25">
+      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.26">
 
 
 
@@ -198,7 +198,7 @@
 
     </form>
     <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
+      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
         <div class="md-search-result" data-md-component="search-result">
           <div class="md-search-result__meta">
             Initializing search
@@ -2169,7 +2169,7 @@ <h1 id="properties-and-annotations-implementation-details">Properties and annota
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.sections", "search.highlight", "search.share", "search.suggest", "toc.follow", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
 
 
-      <script src="../../assets/javascripts/bundle.081f42fc.min.js"></script>
+      <script src="../../assets/javascripts/bundle.ad660dcc.min.js"></script>
 
         <script src="../../termynal.js"></script>