Sign upLogin

lucydot/effmass

View on GitHub
Star
docs/build/genindex.html

Summary

Maintainability
Test Coverage


<!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>Index &mdash; 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="#" />
    <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"> 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>
<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"><a class="reference internal" href="Related%20packages.html">Related packages</a></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> &raquo;</li>
        
      <li>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="#_"><strong>_</strong></a>
 | <a href="#A"><strong>A</strong></a>
 | <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</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="#K"><strong>K</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#N"><strong>N</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>
 | <a href="#V"><strong>V</strong></a>
 | <a href="#W"><strong>W</strong></a>
 
</div>
<h2 id="_">_</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.__init__">__init__() (effmass.analysis.Segment method)</a>

      <ul>
        <li><a href="analysis.html#effmass.analysis.SegmentVasp.__init__">(effmass.analysis.SegmentVasp method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.Data.__init__">(effmass.inputs.Data method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataAims.__init__">(effmass.inputs.DataAims method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataASE.__init__">(effmass.inputs.DataASE method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataCastep.__init__">(effmass.inputs.DataCastep method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataVasp.__init__">(effmass.inputs.DataVasp method)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.Settings.__init__">(effmass.inputs.Settings method)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.alpha">alpha() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.band">band (effmass.analysis.Segment attribute)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.band_type">band_type (effmass.analysis.Segment attribute)</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="extrema.html#effmass.extrema.calc_CBM_VBM_from_Fermi">calc_CBM_VBM_from_Fermi() (in module effmass.extrema)</a>
</li>
      <li><a href="extrema.html#effmass.extrema.calculate_direction">calculate_direction() (in module effmass.extrema)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.cartesian_kpoints">cartesian_kpoints (effmass.analysis.Segment attribute)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.Data.CBM">CBM (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.CBM">(effmass.inputs.DataAims attribute)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="extrema.html#effmass.extrema.change_direction">change_direction() (in module effmass.extrema)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.Data.check_data">check_data() (effmass.inputs.Data method)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.Settings.check_settings">check_settings() (effmass.inputs.Settings method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="inputs.html#effmass.inputs.Data">Data (class in effmass.inputs)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.DataAims">DataAims (class in effmass.inputs)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.DataASE">DataASE (class in effmass.inputs)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.DataCastep">DataCastep (class in effmass.inputs)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.DataVasp">DataVasp (class in effmass.inputs)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.dE_eV">dE_eV (effmass.analysis.Segment attribute)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.dE_hartree">dE_hartree (effmass.analysis.Segment attribute)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.direction">direction (effmass.analysis.Segment attribute)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.dk_angs">dk_angs (effmass.analysis.Segment attribute)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.dk_bohr">dk_bohr (effmass.analysis.Segment attribute)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    effmass.analysis

      <ul>
        <li><a href="API%20documentation.html#module-effmass.analysis">module</a>, <a href="analysis.html#module-effmass.analysis">[1]</a>
</li>
      </ul></li>
      <li>
    effmass.dos

      <ul>
        <li><a href="API%20documentation.html#module-effmass.dos">module</a>, <a href="dos.html#module-effmass.dos">[1]</a>
</li>
      </ul></li>
      <li>
    effmass.extrema

      <ul>
        <li><a href="API%20documentation.html#module-effmass.extrema">module</a>, <a href="extrema.html#module-effmass.extrema">[1]</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    effmass.inputs

      <ul>
        <li><a href="API%20documentation.html#module-effmass.inputs">module</a>, <a href="inputs.html#module-effmass.inputs">[1]</a>
</li>
      </ul></li>
      <li><a href="dos.html#effmass.dos.electron_fill_level">electron_fill_level() (in module effmass.dos)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.energies">energies (effmass.analysis.Segment attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.Data.energies">(effmass.inputs.Data attribute)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataAims.energies">(effmass.inputs.DataAims attribute)</a>
</li>
      </ul></li>
      <li><a href="analysis.html#effmass.analysis.Segment.explosion_index">explosion_index() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.fd">fd() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.fermi_energy">fermi_energy (effmass.analysis.Segment attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.Data.fermi_energy">(effmass.inputs.Data attribute)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataAims.fermi_energy">(effmass.inputs.DataAims attribute)</a>, <a href="inputs.html#id0">[1]</a>
</li>
      </ul></li>
      <li><a href="dos.html#effmass.dos.find_dos_CBM_index">find_dos_CBM_index() (in module effmass.dos)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="dos.html#effmass.dos.find_dos_VBM_index">find_dos_VBM_index() (in module effmass.dos)</a>
</li>
      <li><a href="extrema.html#effmass.extrema.find_extrema_indices">find_extrema_indices() (in module effmass.extrema)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.finite_difference_effmass">finite_difference_effmass() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.finite_difference_fit">finite_difference_fit() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.five_point_leastsq_effmass">five_point_leastsq_effmass() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.five_point_leastsq_fit">five_point_leastsq_fit() (effmass.analysis.Segment method)</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><a href="extrema.html#effmass.extrema.generate_segments">generate_segments() (in module effmass.extrema)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="extrema.html#effmass.extrema.get_kpoints_after">get_kpoints_after() (in module effmass.extrema)</a>
</li>
      <li><a href="extrema.html#effmass.extrema.get_kpoints_before">get_kpoints_before() (in module effmass.extrema)</a>
</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="dos.html#effmass.dos.hole_fill_level">hole_fill_level() (in module effmass.dos)</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="analysis.html#effmass.analysis.Segment.inertial_effmass">inertial_effmass() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.kane_fit">kane_fit() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.kane_mass_band_edge">kane_mass_band_edge() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.kpoint_indices">kpoint_indices (effmass.analysis.Segment attribute)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.kpoints">kpoints (effmass.analysis.Segment attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.Data.kpoints">(effmass.inputs.Data attribute)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataAims.kpoints">(effmass.inputs.DataAims attribute)</a>
</li>
      </ul></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="analysis.html#effmass.analysis.Segment.mass_integration">mass_integration() (effmass.analysis.Segment method)</a>
</li>
      <li>
    module

      <ul>
        <li><a href="API%20documentation.html#module-effmass.analysis">effmass.analysis</a>, <a href="analysis.html#module-effmass.analysis">[1]</a>
</li>
        <li><a href="API%20documentation.html#module-effmass.dos">effmass.dos</a>, <a href="dos.html#module-effmass.dos">[1]</a>
</li>
        <li><a href="API%20documentation.html#module-effmass.extrema">effmass.extrema</a>, <a href="extrema.html#module-effmass.extrema">[1]</a>
</li>
        <li><a href="API%20documentation.html#module-effmass.inputs">effmass.inputs</a>, <a href="inputs.html#module-effmass.inputs">[1]</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="inputs.html#effmass.inputs.Data.number_of_bands">number_of_bands (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.number_of_bands">(effmass.inputs.DataAims attribute)</a>, <a href="inputs.html#id1">[1]</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="inputs.html#effmass.inputs.Data.number_of_kpoints">number_of_kpoints (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.number_of_kpoints">(effmass.inputs.DataAims attribute)</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="analysis.html#effmass.analysis.Segment.occupancy">occupancy (effmass.analysis.Segment attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.Data.occupancy">(effmass.inputs.Data attribute)</a>
</li>
        <li><a href="inputs.html#effmass.inputs.DataAims.occupancy">(effmass.inputs.DataAims attribute)</a>
</li>
      </ul></li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.optical_effmass_kane_dispersion">optical_effmass_kane_dispersion() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.optical_poly_effmass">optical_poly_effmass() (effmass.analysis.Segment method)</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="inputs.html#effmass.inputs.DataVasp.parse_DOSCAR">parse_DOSCAR() (effmass.inputs.DataVasp method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.poly_derivatives">poly_derivatives() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.poly_fit">poly_fit() (effmass.analysis.Segment method)</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="inputs.html#effmass.inputs.Data.reciprocal_lattice">reciprocal_lattice (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.reciprocal_lattice">(effmass.inputs.DataAims attribute)</a>, <a href="inputs.html#id2">[1]</a>
</li>
      </ul></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="analysis.html#effmass.analysis.Segment">Segment (class in effmass.analysis)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.SegmentVasp">SegmentVasp (class in effmass.analysis)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="inputs.html#effmass.inputs.Settings">Settings (class in effmass.inputs)</a>
</li>
      <li><a href="inputs.html#effmass.inputs.Data.spin_channels">spin_channels (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.spin_channels">(effmass.inputs.DataAims attribute)</a>, <a href="inputs.html#id3">[1]</a>
</li>
      </ul></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="analysis.html#effmass.analysis.Segment.transport_effmass">transport_effmass() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="inputs.html#effmass.inputs.Data.VBM">VBM (effmass.inputs.Data attribute)</a>

      <ul>
        <li><a href="inputs.html#effmass.inputs.DataAims.VBM">(effmass.inputs.DataAims attribute)</a>
</li>
      </ul></li>
  </ul></td>
</tr></table>

<h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.weight_integration">weight_integration() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.weighted_leastsq_effmass">weighted_leastsq_effmass() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="analysis.html#effmass.analysis.Segment.weighted_leastsq_fit">weighted_leastsq_fit() (effmass.analysis.Segment method)</a>
</li>
      <li><a href="analysis.html#effmass.analysis.Segment.weighting">weighting() (effmass.analysis.Segment method)</a>
</li>
  </ul></td>
</tr></table>



           </div>
           
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; 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>