update docs

Author: akashdhruv

docs/README.html

@@ -83,7 +83,7 @@
   <div class="section" id="icon-boxkit">
 <h1><a class="reference internal" href="_images/icon.svg"><img alt="icon" src="_images/icon.svg" width="30" /></a> BoxKit<a class="headerlink" href="#icon-boxkit" title="Permalink to this headline"></a></h1>
 <p><a class="reference external" href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a></p>
-<p><img alt="FlashX" src="https://github.com/akashdhruv/BoxKit/workflows/FlashX/badge.svg" /> <img alt="FlowX" src="https://github.com/akashdhruv/BoxKit/workflows/FlowX/badge.svg" /> <img alt="Minimal" src="https://github.com/akashdhruv/BoxKit/workflows/Minimal/badge.svg" /> <img alt="Publish" src="https://github.com/akashdhruv/BoxKit/workflows/Publish/badge.svg" /> <img alt="Linting" src="https://github.com/akashdhruv/BoxKit/workflows/Linting/badge.svg" /></p>
+<p><img alt="FlashX" src="https://github.com/Box-Tools/BoxKit/workflows/FlashX/badge.svg" /> <img alt="FlowX" src="https://github.com/Box-Tools/BoxKit/workflows/FlowX/badge.svg" /> <img alt="Minimal" src="https://github.com/Box-Tools/BoxKit/workflows/Minimal/badge.svg" /> <img alt="Publish" src="https://github.com/Box-Tools/BoxKit/workflows/Publish/badge.svg" /> <img alt="Linting" src="https://github.com/Box-Tools/BoxKit/workflows/Linting/badge.svg" /></p>
 <div class="section" id="overview">
 <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h2>
 <p>BoxKit is a library that provides building blocks to parallelize and
@@ -115,7 +115,7 @@ <h2>Installation<a class="headerlink" href="#installation" title="Permalink to t
 </div>
 <p>Pre-release version can be installed directly from the git reposity by
 executing,</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">ssh</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">akashdhruv</span><span class="o">/</span><span class="n">BoxKit</span><span class="o">.</span><span class="n">git</span> <span class="o">--</span><span class="n">user</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">ssh</span><span class="p">:</span><span class="o">//</span><span class="n">git</span><span class="nd">@github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">Box</span><span class="o">-</span><span class="n">Tools</span><span class="o">/</span><span class="n">BoxKit</span><span class="o">.</span><span class="n">git</span> <span class="o">--</span><span class="n">user</span>
 </pre></div>
 </div>
 <p>BoxKit provides various installation options that can be used to
@@ -240,13 +240,13 @@ <h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">
 parallelization schema of target applications like SciKit, OpticalFlow,
 and PyTorch which function independently using available resources.</p>
 <p>Detailed information on full functionality is availabe in documentation
-(<a class="reference external" href="https://akashdhruv.github.io/BoxKit/">https://akashdhruv.github.io/BoxKit/</a>).</p>
+(<a class="reference external" href="https://box-tools.github.io/BoxKit/">https://box-tools.github.io/BoxKit/</a>).</p>
 </div>
 <div class="section" id="contribution">
 <h2>Contribution<a class="headerlink" href="#contribution" title="Permalink to this headline"></a></h2>
 <p>Developers are encouraged to fork the repository and contribute to the
 source code in the form of pull requests to the <code class="docutils literal notranslate"><span class="pre">development</span></code> branch.
-Please read documentation (<a class="reference external" href="https://akashdhruv.github.io/BoxKit/">https://akashdhruv.github.io/BoxKit/</a>) for an
+Please read documentation (<a class="reference external" href="https://box-tools.github.io/BoxKit/">https://box-tools.github.io/BoxKit/</a>) for an
 overview of software design and developer guide</p>
 </div>
 <div class="section" id="testing">

docs/_sources/README.rst.txt

@@ -50,7 +50,7 @@ executing,
 
 .. code::
 
-   pip install git+ssh://[email protected]/akashdhruv/BoxKit.git --user
+   pip install git+ssh://[email protected]/Box-Tools/BoxKit.git --user
 
 BoxKit provides various installation options that can be used to
 configure the library with desired features. Following is a list of
@@ -205,15 +205,15 @@ parallelization schema of target applications like SciKit, OpticalFlow,
 and PyTorch which function independently using available resources.
 
 Detailed information on full functionality is availabe in documentation
-(https://akashdhruv.github.io/BoxKit/).
+(https://box-tools.github.io/BoxKit/).
 
 **************
  Contribution
 **************
 
 Developers are encouraged to fork the repository and contribute to the
 source code in the form of pull requests to the ``development`` branch.
-Please read documentation (https://akashdhruv.github.io/BoxKit/) for an
+Please read documentation (https://box-tools.github.io/BoxKit/) for an
 overview of software design and developer guide
 
 *********
@@ -268,15 +268,15 @@ features, and ask questions about usage
 .. |Code style: black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
 
-.. |FlashX| image:: https://github.com/akashdhruv/BoxKit/workflows/FlashX/badge.svg
+.. |FlashX| image:: https://github.com/Box-Tools/BoxKit/workflows/FlashX/badge.svg
 
-.. |FlowX| image:: https://github.com/akashdhruv/BoxKit/workflows/FlowX/badge.svg
+.. |FlowX| image:: https://github.com/Box-Tools/BoxKit/workflows/FlowX/badge.svg
 
-.. |Minimal| image:: https://github.com/akashdhruv/BoxKit/workflows/Minimal/badge.svg
+.. |Minimal| image:: https://github.com/Box-Tools/BoxKit/workflows/Minimal/badge.svg
 
-.. |Publish| image:: https://github.com/akashdhruv/BoxKit/workflows/Publish/badge.svg
+.. |Publish| image:: https://github.com/Box-Tools/BoxKit/workflows/Publish/badge.svg
 
-.. |Linting| image:: https://github.com/akashdhruv/BoxKit/workflows/Linting/badge.svg
+.. |Linting| image:: https://github.com/Box-Tools/BoxKit/workflows/Linting/badge.svg
 
 .. |icon| image:: ./media/icon.svg
    :width: 30

docs/boxkit.api._read.html

@@ -84,7 +84,7 @@
 <p>Module with implemenetation of api read methods</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="boxkit.api._read.read_dataset">
-<span class="sig-prename descclassname"><span class="pre">boxkit.api._read.</span></span><span class="sig-name descname"><span class="pre">read_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_memmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nthreads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'serial'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.api._read.read_dataset" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">boxkit.api._read.</span></span><span class="sig-name descname"><span class="pre">read_dataset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">source</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">storage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_memmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nthreads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'serial'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'auto'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.api._read.read_dataset" title="Permalink to this definition"></a></dt>
 <dd><p>Create a dataset from a file</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
@@ -94,6 +94,10 @@
 ‘flash’  : method to create FLASH dataset</p></li>
 <li><p><strong>storage</strong> (<em>storage option 'disk'</em><em>, </em><em>'pyarrow'</em><em>, or </em><em>'dask'</em>) – default(‘disk’)</p></li>
 <li><p><strong>server</strong> (<em>server dictionary</em>) – </p></li>
+<li><p><strong>force_memamp</strong> (<em>flag</em>) – </p></li>
+<li><p><strong>nthreads</strong> (<em>integer</em>) – </p></li>
+<li><p><strong>backend</strong> (<em>string parameter for parallel backend</em>) – </p></li>
+<li><p><strong>monitor</strong> (<em>flag</em>) – </p></li>
 <li><p><strong>references</strong><strong>)</strong> (<em>(</em><em>see tests/boiling.py and tests/heater.py for</em>) – </p></li>
 </ul>
 </dd>

docs/boxkit.resources.read._flash.html

@@ -85,7 +85,7 @@
 <p>Module to read attributes from FLASH output files</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="boxkit.resources.read._flash.read_flash">
-<span class="sig-prename descclassname"><span class="pre">boxkit.resources.read._flash.</span></span><span class="sig-name descname"><span class="pre">read_flash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.resources.read._flash.read_flash" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">boxkit.resources.read._flash.</span></span><span class="sig-name descname"><span class="pre">read_flash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nthreads</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.resources.read._flash.read_flash" title="Permalink to this definition"></a></dt>
 <dd><p>Read dataset from FLASH output file</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>

docs/boxkit.resources.read._sample.html

@@ -84,7 +84,7 @@
 <p>Module to read attributes from default files</p>
 <dl class="py function">
 <dt class="sig sig-object py" id="boxkit.resources.read._sample.read_test_sample">
-<span class="sig-prename descclassname"><span class="pre">boxkit.resources.read._sample.</span></span><span class="sig-name descname"><span class="pre">read_test_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.resources.read._sample.read_test_sample" title="Permalink to this definition"></a></dt>
+<span class="sig-prename descclassname"><span class="pre">boxkit.resources.read._sample.</span></span><span class="sig-name descname"><span class="pre">read_test_sample</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">server</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nthreads</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">monitor</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">backend</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#boxkit.resources.read._sample.read_test_sample" title="Permalink to this definition"></a></dt>
 <dd><p>Read dataset from BoxKit test sample</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>