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.
149 lines
6.5 KiB
149 lines
6.5 KiB
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>Introduction — 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="Quickstart" href="quickstart/index.html" />
|
||
|
|
<link rel="prev" title="grogupy: Script for calculating magnetic interactions" href="index.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 class="current">
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#package">Package</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#command-line-usage">Command line usage</a></li>
|
||
|
|
</ul>
|
||
|
|
</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>
|
||
|
2 months ago
|
<li class="toctree-l1"><a class="reference internal" href="implementation/modules.html">src</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="implementation/grogupy.html">grogupy package</a></li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="implementation/environment.html">Environment variables</a></li>
|
||
|
2 months ago
|
</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 active">Introduction</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
<a href="_sources/introduction.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="introduction">
|
||
|
|
<h1>Introduction<a class="headerlink" href="#introduction" title="Link to this heading"></a></h1>
|
||
|
|
<p>The format of the documentation was based on and inspired by <a class="reference external" href="https://sisl.readthedocs.io/en/latest/index.html">sisl</a>.
|
||
|
|
1.</p>
|
||
|
|
<ol class="arabic simple" start="2">
|
||
|
|
<li></li>
|
||
|
|
</ol>
|
||
|
|
<section id="package">
|
||
|
|
<h2>Package<a class="headerlink" href="#package" title="Link to this heading"></a></h2>
|
||
|
|
<p>Go to <a class="reference internal" href="quickstart/index.html#quickstart"><span class="std std-ref">installation</span></a>.</p>
|
||
|
|
</section>
|
||
|
|
<section id="command-line-usage">
|
||
|
|
<h2>Command line usage<a class="headerlink" href="#command-line-usage" title="Link to this heading"></a></h2>
|
||
|
|
<p>Coming soon…</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
|
|
<a href="index.html" class="btn btn-neutral float-left" title="grogupy: Script for calculating magnetic interactions" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
|
|
<a href="quickstart/index.html" class="btn btn-neutral float-right" title="Quickstart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>© 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>
|