<!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.0" / >
< title > Index — 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 = "#" / >
< link rel = "search" title = "Search" href = "search.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 >
< 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 >
< / 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" > Index< / li >
< li class = "wy-breadcrumbs-aside" >
< / li >
< / ul >
< hr / >
< / div >
< div role = "main" class = "document" itemscope = "itemscope" itemtype = "http://schema.org/Article" >
< div itemprop = "articleBody" >
< h1 id = "index" > Index< / h1 >
< div class = "genindex-jumpbox" >
< a href = "#B" > < strong > B< / strong > < / a >
| < a href = "#C" > < strong > C< / strong > < / a >
| < a href = "#G" > < strong > G< / strong > < / a >
| < a href = "#H" > < strong > H< / strong > < / a >
| < a href = "#I" > < strong > I< / strong > < / a >
| < a href = "#L" > < strong > L< / strong > < / a >
| < a href = "#M" > < strong > M< / strong > < / a >
| < a href = "#O" > < strong > O< / strong > < / a >
| < a href = "#P" > < strong > P< / strong > < / a >
| < a href = "#R" > < strong > R< / strong > < / a >
| < a href = "#S" > < strong > S< / strong > < / a >
| < a href = "#T" > < strong > T< / strong > < / a >
< / div >
< h2 id = "B" > B< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.magnetism.blow_up_orbindx" > blow_up_orbindx() (in module grogupy.magnetism)< / a >
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.build_hh_ss" > build_hh_ss() (in module grogupy.core)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "C" > C< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.calc_Vu" > calc_Vu() (in module grogupy.core)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.magnetism.calculate_anisotropy_tensor" > calculate_anisotropy_tensor() (in module grogupy.magnetism)< / a >
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.magnetism.calculate_exchange_tensor" > calculate_exchange_tensor() (in module grogupy.magnetism)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.commutator" > commutator() (in module grogupy.utilities)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.crossM" > crossM() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "G" > G< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li >
grogupy
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy" > module< / a > , < a href = "index.html#module-grogupy" > [1]< / a >
< / li >
< / ul > < / li >
< li >
grogupy.core
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy.core" > module< / a >
< / li >
< / ul > < / li >
< li >
grogupy.grogu
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy.grogu" > module< / a >
< / li >
< / ul > < / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li >
grogupy.io
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy.io" > module< / a >
< / li >
< / ul > < / li >
< li >
grogupy.magnetism
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy.magnetism" > module< / a >
< / li >
< / ul > < / li >
< li >
grogupy.utilities
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy.utilities" > module< / a >
< / li >
< / ul > < / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "H" > H< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.hsk" > hsk() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "I" > I< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.int_de_ke" > int_de_ke() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "L" > L< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.io.load_pickle" > load_pickle() (in module grogupy.io)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "M" > M< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.grogu.main" > main() (in module grogupy.grogu)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.make_contour" > make_contour() (in module grogupy.utilities)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.make_kset" > make_kset() (in module grogupy.utilities)< / a >
< / li >
< li >
module
< ul >
< li > < a href = "implementation/grogupy.html#module-grogupy" > grogupy< / a > , < a href = "index.html#module-grogupy" > [1]< / a >
< / li >
< li > < a href = "implementation/grogupy.html#module-grogupy.core" > grogupy.core< / a >
< / li >
< li > < a href = "implementation/grogupy.html#module-grogupy.grogu" > grogupy.grogu< / a >
< / li >
< li > < a href = "implementation/grogupy.html#module-grogupy.io" > grogupy.io< / a >
< / li >
< li > < a href = "implementation/grogupy.html#module-grogupy.magnetism" > grogupy.magnetism< / a >
< / li >
< li > < a href = "implementation/grogupy.html#module-grogupy.utilities" > grogupy.utilities< / a >
< / li >
< / ul > < / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "O" > O< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.onsite_projection" > onsite_projection() (in module grogupy.core)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "P" > P< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.parallel_Gk" > parallel_Gk() (in module grogupy.core)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.grogu.parse_command_line" > parse_command_line() (in module grogupy.grogu)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.magnetism.parse_magnetic_entity" > parse_magnetic_entity() (in module grogupy.magnetism)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.io.print_atoms_and_pairs" > print_atoms_and_pairs() (in module grogupy.io)< / a >
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.io.print_job_description" > print_job_description() (in module grogupy.io)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.io.print_parameters" > print_parameters() (in module grogupy.io)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.io.print_runtime_information" > print_runtime_information() (in module grogupy.io)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.io.process_input_args" > process_input_args() (in module grogupy.io)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "R" > R< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.io.read_fdf" > read_fdf() (in module grogupy.io)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.read_siesta_emin" > read_siesta_emin() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.remove_clutter_for_save" > remove_clutter_for_save() (in module grogupy.core)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.RotM" > RotM() (in module grogupy.utilities)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.RotMa2b" > RotMa2b() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "S" > S< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.io.save_pickle" > save_pickle() (in module grogupy.io)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.core.sequential_GK" > sequential_GK() (in module grogupy.core)< / a >
< / li >
< / ul > < / td >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.core.setup_pairs_and_magnetic_entities" > setup_pairs_and_magnetic_entities() (in module grogupy.core)< / a >
< / li >
< li > < a href = "implementation/grogupy.html#grogupy.magnetism.spin_tracer" > spin_tracer() (in module grogupy.magnetism)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< h2 id = "T" > T< / h2 >
< table style = "width: 100%" class = "indextable genindextable" > < tr >
< td style = "width: 33%; vertical-align: top;" > < ul >
< li > < a href = "implementation/grogupy.html#grogupy.utilities.tau_u" > tau_u() (in module grogupy.utilities)< / a >
< / li >
< / ul > < / td >
< / tr > < / table >
< / div >
< / div >
< footer >
< 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 >