.. effmass documentation master file, created by
   sphinx-quickstart on Thu Mar 22 12:48:42 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Effmass
=======

.. figure:: .static/electronworries.png
    :align: right
    :figwidth: 300px
    :alt: "Do I look fat in this potential?" -- electron

`effmass` is a Python package for calculating various definitions of effective mass from the electronic bandstructure of a semiconducting material. It consists of a core class that calculates the effective mass and other associated properties of selected bandstructure segments. The module also contains functions for locating bandstructure extrema and plotting approximations to the dispersion.

Examples are provided in a Jupyter notebook tutorial `here <https://nbviewer.jupyter.org/github/lucydot/effmass/blob/master/Tutorial.ipynb>`_.
Source code is available as a git repository at `https://github.com/lucydot/effmass <https://github.com/lucydot/effmass>`_.

Details
-------

:Authors: Lucy Whalley
:Contact: l.whalley@northumbria.ac.uk
:GitHub: https://github.com/lucydot
:Citation: :download:`bibtex<.static/Whalley2018_CITATION.bib>`

.. image:: https://badge.fury.io/py/effmass.svg
   :target: https://pypi.org/project/effmass/0.1.0/  
.. image:: https://readthedocs.org/projects/pip/badge/?version=latest
   :target: http://effmass.readthedocs.io/en/latest/?badge=latest
.. image:: https://travis-ci.com/lucydot/effmass.svg?branch=master
   :target: https://travis-ci.com/lucydot/effmass
.. image:: https://codeclimate.com/github/lucydot/effmass/badges/coverage.svg
   :target: https://codeclimate.com/github/lucydot/effmass/code
.. image:: https://zenodo.org/badge/136037407.svg
   :target: https://zenodo.org/record/1285137#.Wx6QdFMvxBw
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
.. image:: http://joss.theoj.org/papers/10.21105/joss.00797/status.svg
   :target: https://doi.org/10.21105/joss.00797

Documentation
-------------

.. toctree::
   :maxdepth: 2
   
   Features
   Supported codes
   Installation
   API documentation
   Implementation
   Related packages
   Development
   Testing
   Citing
   License
   Contributors
   Acknowledgements





