<!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 content = "Relativistic magnetic interactions from non-orthogonal basis sets." name = "description" / >
< meta content = "DFT, physics, grogu, magnetic interactions, Siesta" name = "keywords" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > grogupy: Script for calculating magnetic interactions — 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 = "Introduction" href = "introduction.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" >
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 >
< li class = "toctree-l1" > < a class = "reference internal" href = "implementation/index.html" > Implementation< / a > < / 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 = "#" > 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 = "#" class = "icon icon-home" aria-label = "Home" > < / a > < / li >
< li class = "breadcrumb-item active" > grogupy: Script for calculating magnetic interactions< / 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 = "grogupy-script-for-calculating-magnetic-interactions" >
< span id = "module-grogupy" > < / span > < h1 > grogupy: Script for calculating magnetic interactions< a class = "headerlink" href = "#grogupy-script-for-calculating-magnetic-interactions" title = "Link to this heading" > < / a > < / h1 >
< p > Groupy is a generalized python script based on the Grogu matlab implementation.
More on the theoretical background can be seen < a class = "reference external" href = "https://arxiv.org/abs/2309.02558" > here< / a > .< / p >
< div class = "sd-container-fluid sd-sphinx-override sd-mb-4 docutils" >
< div class = "sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-2 sd-g-xs-2 sd-g-sm-2 sd-g-md-2 sd-g-lg-2 docutils" >
< div class = "sd-col sd-d-flex-row docutils" >
< div class = "sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils" >
< div class = "sd-card-body docutils" >
< div class = "sd-card-title sd-font-weight-bold docutils" >
– < / div >
< p class = "sd-card-text" > Basic tutorial on how to use the < cite > grogupy< / cite > script.< / p >
< / div >
< a class = "sd-stretched-link sd-hide-link-text reference internal" href = "quickstart/index.html" > < span class = "doc" > Quickstart< / span > < / a > < / div >
< / div >
< div class = "sd-col sd-d-flex-row docutils" >
< div class = "sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils" >
< div class = "sd-card-body docutils" >
< div class = "sd-card-title sd-font-weight-bold docutils" >
– < / div >
< p class = "sd-card-text" > Detailed description of the implementation.< / p >
< / div >
< a class = "sd-stretched-link sd-hide-link-text reference internal" href = "implementation/index.html" > < span class = "doc" > Implementation< / span > < / a > < / div >
< / div >
< / div >
< / div >
< div class = "toctree-wrapper compound" >
< / div >
< div class = "toctree-wrapper compound" >
< / div >
< div class = "toctree-wrapper compound" >
< / div >
< div class = "toctree-wrapper compound" >
< / div >
< div class = "toctree-wrapper compound" >
< / 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 = "introduction.html" class = "btn btn-neutral float-right" title = "Introduction" 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 >
