5505-public/dima
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Files
main
dima/docs/build/html/index.html

178 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to DIMA’s documentation! &mdash; DIMA 1.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=8d563738"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.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="HDF5 Data Operations" href="modules/src.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="#" class="icon icon-home">
DIMA
</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" aria-label="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>
<li class="toctree-l1"><a class="reference internal" href="modules/src.html">HDF5 Data Operations</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/src.html#module-src.hdf5_writer">HDF5 Writer</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/pipelines.html">Pipelines and workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/vis.html">Data Visualization</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/utils.html">Data Structure Conversion</a></li>
<li class="toctree-l1"><a class="reference internal" href="modules/notebooks.html">Notebooks</a></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="#">DIMA</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="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to DIMA’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.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">
<section id="welcome-to-dima-s-documentation">
<h1>Welcome to DIMA’s documentation!<a class="headerlink" href="#welcome-to-dima-s-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules/src.html">HDF5 Data Operations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_ops.HDF5DataOpsManager"><code class="docutils literal notranslate"><span class="pre">HDF5DataOpsManager</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_ops.get_groups_at_a_level"><code class="docutils literal notranslate"><span class="pre">get_groups_at_a_level()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_ops.get_parent_child_relationships"><code class="docutils literal notranslate"><span class="pre">get_parent_child_relationships()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_ops.read_mtable_as_dataframe"><code class="docutils literal notranslate"><span class="pre">read_mtable_as_dataframe()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_ops.serialize_metadata"><code class="docutils literal notranslate"><span class="pre">serialize_metadata()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/src.html#module-src.hdf5_writer">HDF5 Writer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_writer.create_hdf5_file_from_dataframe"><code class="docutils literal notranslate"><span class="pre">create_hdf5_file_from_dataframe()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_writer.create_hdf5_file_from_filesystem_path"><code class="docutils literal notranslate"><span class="pre">create_hdf5_file_from_filesystem_path()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/src.html#src.hdf5_writer.save_processed_dataframe_to_hdf5"><code class="docutils literal notranslate"><span class="pre">save_processed_dataframe_to_hdf5()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/pipelines.html">Pipelines and workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.data_integration.copy_subtree_and_create_hdf5"><code class="docutils literal notranslate"><span class="pre">copy_subtree_and_create_hdf5()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.data_integration.load_config_and_setup_logging"><code class="docutils literal notranslate"><span class="pre">load_config_and_setup_logging()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.data_integration.run_pipeline"><code class="docutils literal notranslate"><span class="pre">run_pipeline()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.metadata_revision.count"><code class="docutils literal notranslate"><span class="pre">count()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.metadata_revision.load_yaml"><code class="docutils literal notranslate"><span class="pre">load_yaml()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.metadata_revision.update_hdf5_file_with_review"><code class="docutils literal notranslate"><span class="pre">update_hdf5_file_with_review()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/pipelines.html#pipelines.metadata_revision.validate_yaml_dict"><code class="docutils literal notranslate"><span class="pre">validate_yaml_dict()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/vis.html">Data Visualization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/vis.html#visualization.hdf5_vis.display_group_hierarchy_on_a_treemap"><code class="docutils literal notranslate"><span class="pre">display_group_hierarchy_on_a_treemap()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/utils.html">Data Structure Conversion</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.augment_with_filenumber"><code class="docutils literal notranslate"><span class="pre">augment_with_filenumber()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.augment_with_filetype"><code class="docutils literal notranslate"><span class="pre">augment_with_filetype()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.convert_attrdict_to_np_structured_array"><code class="docutils literal notranslate"><span class="pre">convert_attrdict_to_np_structured_array()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.convert_dataframe_to_np_structured_array"><code class="docutils literal notranslate"><span class="pre">convert_dataframe_to_np_structured_array()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.convert_string_to_bytes"><code class="docutils literal notranslate"><span class="pre">convert_string_to_bytes()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.copy_directory_with_contraints"><code class="docutils literal notranslate"><span class="pre">copy_directory_with_contraints()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.created_at"><code class="docutils literal notranslate"><span class="pre">created_at()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.group_by_df_column"><code class="docutils literal notranslate"><span class="pre">group_by_df_column()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.infer_units"><code class="docutils literal notranslate"><span class="pre">infer_units()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.is_callable_list"><code class="docutils literal notranslate"><span class="pre">is_callable_list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.is_str_list"><code class="docutils literal notranslate"><span class="pre">is_str_list()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.is_structured_array"><code class="docutils literal notranslate"><span class="pre">is_structured_array()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.make_file_copy"><code class="docutils literal notranslate"><span class="pre">make_file_copy()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.progressBar"><code class="docutils literal notranslate"><span class="pre">progressBar()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.sanitize_dataframe"><code class="docutils literal notranslate"><span class="pre">sanitize_dataframe()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.setup_logging"><code class="docutils literal notranslate"><span class="pre">setup_logging()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.split_sample_col_into_sample_and_data_quality_cols"><code class="docutils literal notranslate"><span class="pre">split_sample_col_into_sample_and_data_quality_cols()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/utils.html#utils.g5505_utils.to_serializable_dtype"><code class="docutils literal notranslate"><span class="pre">to_serializable_dtype()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="modules/notebooks.html">Notebooks</a></li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="modules/src.html" class="btn btn-neutral float-right" title="HDF5 Data Operations" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2024, JFFO.</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>
Reference in New Issue View Git Blame Copy Permalink