-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathboxkit.api._read.html
More file actions
143 lines (128 loc) · 8.31 KB
/
Copy pathboxkit.api._read.html
File metadata and controls
143 lines (128 loc) · 8.31 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>boxkit.api._read module — BoxKit documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="boxkit.api._regionprops module" href="boxkit.api._regionprops.html" />
<link rel="prev" title="boxkit.api._mergeblocks module" href="boxkit.api._mergeblocks.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> BoxKit
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="README.html"> BoxKit</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="boxkit.html">boxkit package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="boxkit.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="boxkit.api.html">boxkit.api package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="boxkit.api.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="boxkit.library.html">boxkit.library package</a></li>
<li class="toctree-l3"><a class="reference internal" href="boxkit.resources.html">boxkit.resources package</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BoxKit</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li><a href="boxkit.html">boxkit package</a> »</li>
<li><a href="boxkit.api.html">boxkit.api package</a> »</li>
<li>boxkit.api._read module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/boxkit.api._read.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-boxkit.api._read">
<span id="boxkit-api-read-module"></span><h1>boxkit.api._read module<a class="headerlink" href="#module-boxkit.api._read" title="Permalink to this headline"></a></h1>
<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>, <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>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> (<em>string containing file name</em>) – </p></li>
<li><p><strong>source</strong> (<em>string identifying source/format of the file</em>) – ‘test-sample’ : method to create sample dataset for BoxKit API tests
‘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>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>Dataset object</p>
</dd>
</dl>
</dd></dl>
</div>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="boxkit.api._mergeblocks.html" class="btn btn-neutral float-left" title="boxkit.api._mergeblocks module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="boxkit.api._regionprops.html" class="btn btn-neutral float-right" title="boxkit.api._regionprops module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2022, Akash Dhruv.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>