docs/build/Related packages.html
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Related packages — effmass 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" 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="Development" href="Development.html" />
<link rel="prev" title="Implementation" href="Implementation.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"> effmass
</a>
<div class="version">
1.0.0
</div>
<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="Features.html">Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="Supported%20codes.html">Supported Codes</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="API%20documentation.html">API documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Implementation.html">Implementation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Related packages</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#which-features-are-unique-to-the-effmass-package">Which features are unique to the <cite>effmass</cite> package?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Citing.html">Citing</a></li>
<li class="toctree-l1"><a class="reference internal" href="License.html">License</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="Acknowledgements.html">Acknowledgements</a></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">effmass</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" class="icon icon-home"></a> »</li>
<li>Related packages</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/Related packages.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="related-packages">
<h1>Related packages<a class="headerlink" href="#related-packages" title="Permalink to this headline">¶</a></h1>
<p>The <cite>effmass</cite> package is aimed towards theoretical solid state physicists and chemists who have a basic familiarity with Python.
Depending on the functionality and level of approximation you are looking for,
it may be that one of the packages listed below will suit your needs better.</p>
<p><a class="reference external" href="https://github.com/bjmorgan/vasppy">vasppy</a>: This is installed as a dependancy of <cite>effmass</cite>. Calculates the effective mass using a least-squares quadratic fit for parabolic dispersions.</p>
<p><a class="reference external" href="https://github.com/SMTG-UCL/sumo">sumo</a>: Calculates the effective mass using a least-squares fit for parabolic and non-parabolic dispersions.</p>
<p><a class="reference external" href="https://github.com/afonari/emc">emc</a>: Calculates the effective mass <em>tensor</em> using a finite-difference method for parabolic dispersions.</p>
<p><a class="reference external" href="http://pymatgen.org">pymatgen</a>: This is installed as a dependancy of <cite>effmass</cite>. Calculates an average effective mass <em>tensor</em> for non-parabolic dispersions with multiple bands and extrema. Also calculates the Seebeck effective mass as defined <a class="reference external" href="https://perso.uclouvain.be/geoffroy.hautier/wp-content/papercite-data/pdf/gibbs2017.pdf">here</a>.</p>
<p><a class="reference external" href="https://github.com/rubel75/mstar">mstar</a>: Effective mass calculator using k.p perturbation theory. Assumes parabolicity; provides the conductivity effective mass tensor at band edge. The advantage of this code is that it does not require a DFT calculation along the high symmetry paths in reciprocal space.</p>
<p><a class="reference external" href="https://github.com/PatrizioGraziosi/EMAF-code">EMAF</a>: Calculates the DOS effective mass (at a specific temperature), taking into account non-parabolicity and anisotropy. Also calculates the conductivity effective mass. Written in Matlab.</p>
<p>If you have an update to the information above then please use the Github <a class="reference external" href="https://github.com/lucydot/effmass/issues/">issue tracker</a>.</p>
<div class="section" id="which-features-are-unique-to-the-effmass-package">
<h2>Which features are unique to the <cite>effmass</cite> package?<a class="headerlink" href="#which-features-are-unique-to-the-effmass-package" title="Permalink to this headline">¶</a></h2>
<p>To our knowledge, the following features are unique to <cite>effmass</cite>:</p>
<ul class="simple">
<li><p>easily compare the values of curvature effective mass calculated using multiple numerical techniques (least-squares and polynomial fitting)</p></li>
<li><p>tailor the polynomial fitting used to approximate the DFT calculated dispersion: by choosing the order of the polynomial and the energy range to fit over.</p></li>
<li><p>visualise the dispersions used to approximate the DFT calculated dispersion</p></li>
<li><p>quantify non-parabolicity through the Kane dispersion parameters: effective mass at band-edge and alpha</p></li>
<li><p>calculate the optical effective mass assuming a Kane dispersion.</p></li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="Development.html" class="btn btn-neutral float-right" title="Development" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="Implementation.html" class="btn btn-neutral float-left" title="Implementation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Lucy Whalley.
</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 type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>