https://github.com/romerogroup/pyprocar
Revision e5149c529e11d44cd206d323df17f7759cf21f8a authored by Uthpala Herath on 24 February 2020, 16:59:40 UTC, committed by Uthpala Herath on 24 February 2020, 16:59:40 UTC
1 parent d45d056
Tip revision: e5149c529e11d44cd206d323df17f7759cf21f8a authored by Uthpala Herath on 24 February 2020, 16:59:40 UTC
Fixed band unfolding bug
Fixed band unfolding bug
Tip revision: e5149c5
tutorials.html
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Tutorials — PyProcar 3.6 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Generating a k-path" href="kpath.html" />
<link rel="prev" title="How to cite" href="cite.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"> PyProcar
</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" />
<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="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributors.html">Contributors</a></li>
<li class="toctree-l1"><a class="reference internal" href="cite.html">How to cite</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Tutorials</a><ul>
<li class="toctree-l2"><a class="reference internal" href="kpath.html">Generating a k-path</a></li>
<li class="toctree-l2"><a class="reference internal" href="repair.html">Repair</a></li>
<li class="toctree-l2"><a class="reference internal" href="kmesh.html">k-mesh generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="bands.html">Band structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="2Dspin.html">2D spin-texture</a></li>
<li class="toctree-l2"><a class="reference internal" href="3Dspin.html">3D Fermi surface</a></li>
<li class="toctree-l2"><a class="reference internal" href="filter.html">Filtering data</a></li>
<li class="toctree-l2"><a class="reference internal" href="comparebands.html">Compare bands</a></li>
<li class="toctree-l2"><a class="reference internal" href="cat.html">Concatenating multiple calculations</a></li>
<li class="toctree-l2"><a class="reference internal" href="unfold.html">Band unfolding</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PyProcar</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Tutorials</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/tutorials.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">
<div class="section" id="tutorials">
<h1>Tutorials<a class="headerlink" href="#tutorials" title="Permalink to this headline">ΒΆ</a></h1>
<p>The following set of tutorials explains the basic usage of PyProcar. Files required to run these calculations are available in the /examples directory in the github repo.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="kpath.html">Generating a k-path</a></li>
<li class="toctree-l1"><a class="reference internal" href="repair.html">Repair</a></li>
<li class="toctree-l1"><a class="reference internal" href="kmesh.html">k-mesh generator</a></li>
<li class="toctree-l1"><a class="reference internal" href="bands.html">Band structure</a><ul>
<li class="toctree-l2"><a class="reference internal" href="bands.html#plain-band-structure">1. Plain band structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="bands.html#spin-projection">2. Spin projection</a></li>
<li class="toctree-l2"><a class="reference internal" href="bands.html#atom-projection">3. Atom projection</a></li>
<li class="toctree-l2"><a class="reference internal" href="bands.html#orbital-projection">4. Orbital projection</a></li>
<li class="toctree-l2"><a class="reference internal" href="bands.html#export-plot-as-a-matplotlib-pyplot-object">Export plot as a matplotlib.pyplot object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="2Dspin.html">2D spin-texture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="2Dspin.html#translate-and-rotate-the-2d-kpoint-mesh">Translate and Rotate the 2D KPOINT mesh</a></li>
<li class="toctree-l2"><a class="reference internal" href="2Dspin.html#export-plot-as-a-matplotlib-pyplot-object">Export plot as a matplotlib.pyplot object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="3Dspin.html">3D Fermi surface</a><ul>
<li class="toctree-l2"><a class="reference internal" href="3Dspin.html#plain-fermi-surface">1. Plain Fermi surface</a></li>
<li class="toctree-l2"><a class="reference internal" href="3Dspin.html#surface-coloring-based-on-properties-from-procar">2. Surface coloring based on properties from PROCAR</a></li>
<li class="toctree-l2"><a class="reference internal" href="3Dspin.html#surface-coloring-based-on-properties-obtained-from-an-external-file">3. Surface coloring based on properties obtained from an external file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="filter.html">Filtering data</a><ul>
<li class="toctree-l2"><a class="reference internal" href="filter.html#to-filter-selected-orbitals">To filter selected orbitals</a></li>
<li class="toctree-l2"><a class="reference internal" href="filter.html#to-filter-selected-k-points">To filter selected <span class="math notranslate nohighlight">\(k\)</span>-points</a></li>
<li class="toctree-l2"><a class="reference internal" href="filter.html#to-filter-selected-spins">To filter selected spins</a></li>
<li class="toctree-l2"><a class="reference internal" href="filter.html#to-filter-selected-atoms">To filter selected atoms</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="comparebands.html">Compare bands</a><ul>
<li class="toctree-l2"><a class="reference internal" href="comparebands.html#export-plot-as-a-matplotlib-pyplot-object">Export plot as a matplotlib.pyplot object</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cat.html">Concatenating multiple calculations</a></li>
<li class="toctree-l1"><a class="reference internal" href="unfold.html">Band unfolding</a><ul>
<li class="toctree-l2"><a class="reference internal" href="unfold.html#export-plot-as-a-matplotlib-pyplot-object">Export plot as a matplotlib.pyplot object</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="kpath.html" class="btn btn-neutral float-right" title="Generating a k-path" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="cite.html" class="btn btn-neutral float-left" title="How to cite" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2019, Uthpala Herath
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Computing file changes ...
