et209d
/
grogu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b4549fe5b2'
${ noResults }
grogu/docs/source/_build/html/implementation/grogupy.io.html

240 lines
14 KiB
Raw Normal View History Unescape

now we have a working documentation
2 months ago
<!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>grogupy.io module &mdash; grogupy 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=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
<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 src="../_static/design-tabs.js?v=f930bc37"></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="grogupy.magnetism module" href="grogupy.magnetism.html" />
<link rel="prev" title="grogupy.grogu module" href="grogupy.grogu.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">
grogupy
</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">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../quickstart/index.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cite.html">Citing grogupy</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">User Guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../tutorials/index.html">Tutorials</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Advanced usage</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="modules.html">src</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="grogupy.html">grogupy package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="grogupy.html#submodules">Submodules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="grogupy.core.html">grogupy.core module</a></li>
<li class="toctree-l3"><a class="reference internal" href="grogupy.grogu.html">grogupy.grogu module</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">grogupy.io module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.load_pickle"><code class="docutils literal notranslate"><span class="pre">load_pickle()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.print_atoms_and_pairs"><code class="docutils literal notranslate"><span class="pre">print_atoms_and_pairs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.print_job_description"><code class="docutils literal notranslate"><span class="pre">print_job_description()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.print_parameters"><code class="docutils literal notranslate"><span class="pre">print_parameters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.print_runtime_information"><code class="docutils literal notranslate"><span class="pre">print_runtime_information()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#grogupy.io.save_pickle"><code class="docutils literal notranslate"><span class="pre">save_pickle()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="grogupy.magnetism.html">grogupy.magnetism module</a></li>
<li class="toctree-l3"><a class="reference internal" href="grogupy.utilities.html">grogupy.utilities module</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="grogupy.html#module-grogupy">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="environment.html">Environment variables</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../dev/index.html">Contributing to grogupy</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Extras</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../changelog/index.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bibliography.html">Bibliography</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="../index.html">grogupy</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" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">src</a></li>
<li class="breadcrumb-item"><a href="grogupy.html">grogupy package</a></li>
<li class="breadcrumb-item active">grogupy.io module</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/implementation/grogupy.io.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="module-grogupy.io">
<span id="grogupy-io-module"></span><h1>grogupy.io module<a class="headerlink" href="#module-grogupy.io" title="Link to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.load_pickle">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">load_pickle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">infile</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#load_pickle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.load_pickle" title="Link to this definition"></a></dt>
<dd><p>Loads the data from the infile with pickle.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>infile<span class="classifier">str</span></dt><dd><p>Path to infile</p>
</dd>
</dl>
</dd>
<dt>Returns:</dt><dd><dl class="simple">
<dt>data<span class="classifier">dict</span></dt><dd><p>A dictionary of data</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.print_atoms_and_pairs">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">print_atoms_and_pairs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">magnetic_entities</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pairs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#print_atoms_and_pairs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.print_atoms_and_pairs" title="Link to this definition"></a></dt>
<dd><p>It prints the pair and magnetic entity information for the grogu out.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>magnetic_entities<span class="classifier">dict</span></dt><dd><p>It contains the data on the magnetic entities</p>
</dd>
<dt>pairs<span class="classifier">dict</span></dt><dd><p>It contains the data on the pairs</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.print_job_description">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">print_job_description</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">simulation_parameters</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#print_job_description"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.print_job_description" title="Link to this definition"></a></dt>
<dd><p>It prints the parameters and the description of the job.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>simulation_parameters<span class="classifier">dict</span></dt><dd><p>It contains the simulations parameters</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.print_parameters">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">print_parameters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">simulation_parameters</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#print_parameters"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.print_parameters" title="Link to this definition"></a></dt>
<dd><p>It prints the simulation parameters for the grogu out.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>simulation_parameters<span class="classifier">dict</span></dt><dd><p>It contains the simulations parameters</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.print_runtime_information">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">print_runtime_information</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#print_runtime_information"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.print_runtime_information" title="Link to this definition"></a></dt>
<dd><p>It prints the runtime information for the grogu out.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>times<span class="classifier">dict</span></dt><dd><p>It contains the runtime data</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="grogupy.io.save_pickle">
<span class="sig-prename descclassname"><span class="pre">grogupy.io.</span></span><span class="sig-name descname"><span class="pre">save_pickle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">outfile</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/grogupy/io.html#save_pickle"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grogupy.io.save_pickle" title="Link to this definition"></a></dt>
<dd><p>Saves the data in the outfile with pickle.</p>
<dl class="simple">
<dt>Args:</dt><dd><dl class="simple">
<dt>outfile<span class="classifier">str</span></dt><dd><p>Path to outfile</p>
</dd>
<dt>data<span class="classifier">dict</span></dt><dd><p>Contains the data</p>
</dd>
</dl>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="grogupy.grogu.html" class="btn btn-neutral float-left" title="grogupy.grogu module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="grogupy.magnetism.html" class="btn btn-neutral float-right" title="grogupy.magnetism module" 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, grogupy.</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>