Skip to content

Update Documentation for 5.0.0 #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aaronayres35 merged 2 commits into from
Dec 17, 2020
Merged

Update Documentation for 5.0.0 #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
208dc81
move current documentation into 4.5
aaronayres35 Dec 17, 2020
9f83b4d
create new 5.0 folder and add current docs there and to root directory
aaronayres35 Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
0 ...ipting/action/start_recording_action.html → ...ipting/action/start_recording_action.html
View file
Open in desktop
File renamed without changes.
0 ...ripting/action/stop_recording_action.html → ...ripting/action/stop_recording_action.html
View file
Open in desktop
File renamed without changes.
0 ...les/apptools/appscripting/bind_event.html → ...les/apptools/appscripting/bind_event.html
View file
Open in desktop
File renamed without changes.
0 ...s/apptools/appscripting/i_bind_event.html → ...s/apptools/appscripting/i_bind_event.html
View file
Open in desktop
File renamed without changes.
0 ...ptools/appscripting/i_script_manager.html → ...ptools/appscripting/i_script_manager.html
View file
Open in desktop
File renamed without changes.
0 ...apptools/appscripting/lazy_namespace.html → ...apptools/appscripting/lazy_namespace.html
View file
Open in desktop
File renamed without changes.
0 ...pptools/appscripting/package_globals.html → ...pptools/appscripting/package_globals.html
View file
Open in desktop
File renamed without changes.
0 ...apptools/appscripting/script_manager.html → ...apptools/appscripting/script_manager.html
View file
Open in desktop
File renamed without changes.
0 ...les/apptools/appscripting/scriptable.html → ...les/apptools/appscripting/scriptable.html
View file
Open in desktop
File renamed without changes.
0 ...pptools/appscripting/scriptable_type.html → ...pptools/appscripting/scriptable_type.html
View file
Open in desktop
File renamed without changes.
0 .../help/help_plugin/action/demo_action.html → .../help/help_plugin/action/demo_action.html
View file
Open in desktop
File renamed without changes.
0 ...s/help/help_plugin/action/doc_action.html → ...s/help/help_plugin/action/doc_action.html
View file
Open in desktop
File renamed without changes.
0 ...lp/help_plugin/action/example_action.html → ...lp/help_plugin/action/example_action.html
View file
Open in desktop
File renamed without changes.
0 ...p/help_plugin/action/load_url_action.html → ...p/help_plugin/action/load_url_action.html
View file
Open in desktop
File renamed without changes.
0 ...pptools/help/help_plugin/action/util.html → ...pptools/help/help_plugin/action/util.html
View file
Open in desktop
File renamed without changes.
0 ...elp/help_plugin/examples_preferences.html → ...elp/help_plugin/examples_preferences.html
View file
Open in desktop
File renamed without changes.
0 .../apptools/help/help_plugin/help_code.html → .../apptools/help/help_plugin/help_code.html
View file
Open in desktop
File renamed without changes.
0 ...s/apptools/help/help_plugin/help_doc.html → ...s/apptools/help/help_plugin/help_doc.html
View file
Open in desktop
File renamed without changes.
0 ...pptools/help/help_plugin/help_plugin.html → ...pptools/help/help_plugin/help_plugin.html
View file
Open in desktop
File renamed without changes.
0 ...elp/help_plugin/help_submenu_manager.html → ...elp/help_plugin/help_submenu_manager.html
View file
Open in desktop
File renamed without changes.
0 ...pptools/help/help_plugin/i_help_code.html → ...pptools/help/help_plugin/i_help_code.html
View file
Open in desktop
File renamed without changes.
0 ...apptools/help/help_plugin/i_help_doc.html → ...apptools/help/help_plugin/i_help_doc.html
View file
Open in desktop
File renamed without changes.
0 ...s/help/help_plugin/preferences_pages.html → ...s/help/help_plugin/preferences_pages.html
View file
Open in desktop
File renamed without changes.
471 changes: 471 additions & 0 deletions 4.5/_modules/apptools/io/file.html
View file
Open in desktop

Large diffs are not rendered by default.

353 changes: 353 additions & 0 deletions 4.5/_modules/apptools/io/h5/dict_node.html
View file
Open in desktop

Large diffs are not rendered by default.

621 changes: 621 additions & 0 deletions 4.5/_modules/apptools/io/h5/file.html
View file
Open in desktop

Large diffs are not rendered by default.

276 changes: 276 additions & 0 deletions 4.5/_modules/apptools/io/h5/table_node.html
View file
Open in desktop

Large diffs are not rendered by default.

157 changes: 157 additions & 0 deletions 4.5/_modules/apptools/io/h5/utils.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8">

<title>apptools.io.h5.utils &mdash; Apptools Documentation</title>

<link rel="stylesheet" type="text/css" href="../../../../_static/css/spc-bootstrap.css">
<link rel="stylesheet" type="text/css" href="../../../../_static/css/spc-extend.css">
<link rel="stylesheet" href="../../../../_static/enthought.css" type="text/css" >
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" >
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../../',
VERSION: '4.6.0.dev77',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/copybutton.js"></script>
<script type="text/javascript" src="../../../../_static/js/wrap_on_dot.js"></script>
<link rel="shortcut icon" href="../../../../_static/img/favicon.ico">
<link rel="index" title="Index" href="../../../../genindex.html" >
<link rel="search" title="Search" href="../../../../search.html" >
<link rel="top" title="Apptools Documentation" href="../../../../index.html" >
<link rel="up" title="Module code" href="../../../index.html" >
</head>
<body>
<div class="container">
<div class="header">
</div>
</div>

<div class="container">
<div class="main">

<div class="row-fluid">
<div class="span12">
<div class="spc-navbar">

<ul class="nav nav-pills pull-left">

<li class="active"><a href="../../../../index.html">Apptools Documentation</a></li>

<li class="active"><a href="../../../index.html" accesskey="U">Module code</a></li>
</ul>


<ul class="nav nav-pills pull-right">
<li class="active">
<a href="../../../../genindex.html" title="General Index"
accesskey="I">index</a>
</li>
<li class="active">
<a href="../../../../py-modindex.html" title="Python Module Index"
>modules</a>
</li>
</ul>

</div>
</div>
</div>


<div class="row-fluid">
<div class="span9">

<div class="bodywrapper">
<div class="body" id="spc-section-body">

<h1>Source code for apptools.io.h5.utils</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">contextlib</span> <span class="k">import</span> <span class="n">contextmanager</span>

<span class="kn">from</span> <span class="nn">.file</span> <span class="k">import</span> <span class="n">H5File</span>


<div class="viewcode-block" id="open_h5file"><a class="viewcode-back" href="../../../../api/apptools.io.h5.html#apptools.io.h5.utils.open_h5file">[docs]</a><span class="nd">@contextmanager</span>
<span class="k">def</span> <span class="nf">open_h5file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s1">&#39;r+&#39;</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Context manager for reading an HDF5 file as an H5File object.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> filename : str</span>
<span class="sd"> HDF5 file name.</span>
<span class="sd"> mode : str</span>
<span class="sd"> Mode to open the file:</span>

<span class="sd"> &#39;r&#39; : Read-only</span>
<span class="sd"> &#39;w&#39; : Write; create new file (an existing file would be deleted).</span>
<span class="sd"> &#39;a&#39; : Read and write to file; create if not existing</span>
<span class="sd"> &#39;r+&#39;: Read and write to file; must already exist</span>

<span class="sd"> See `H5File` for additional keyword arguments.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">h5</span> <span class="o">=</span> <span class="n">H5File</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="n">mode</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">try</span><span class="p">:</span>
<span class="k">yield</span> <span class="n">h5</span>
<span class="k">finally</span><span class="p">:</span>
<span class="n">h5</span><span class="o">.</span><span class="n">close</span><span class="p">()</span></div>
</pre></div>

</div>
</div>
</div>
<div class="spc-rightsidebar span3">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../../index.html">
<img class="logo" src="../../../../_static/img/e-logo.png" alt="Logo">
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
</div>
</div>
</div>

<div class="container container-navbar-bottom">
<div class="spc-navbar">

</div>
</div>
<div class="container">
<div class="footer">
<div class="row-fluid">
<ul class="inline pull-left">
<li>
&copy; Copyright 2008-2020, Enthought
</li>
<li>
Last updated on Jun 12, 2020.
</li>
<li>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.8.5.
</li>
</ul>
</div>
</div>
</div>
</body>
</html>
Loading