README.md
# Effmass
[](https://badge.fury.io/py/effmass)
[](https://effmass.readthedocs.io/en/latest/)
[](https://app.travis-ci.com/github/lucydot/effmass)
[](https://codeclimate.com/github/lucydot/effmass/coverage)
[](https://zenodo.org/badge/latestdoi/136037407)
[](https://opensource.org/licenses/MIT)
[](http://joss.theoj.org/papers/389754561f0710b756514b8cb9ac0e6a)
[](https://bestpractices.coreinfrastructure.org/projects/7405)
[](https://fair-software.eu)
💃 31/5/23: Effmass-2.3.1 has been released!!
💃 Effmass now has more options for locating extrema of a particular type: by direction or band type (conduction/valence/frontier).
⚠️ The `Data` class was renamed `DataVasp` in `effmass` versions 2.0.0+. You may need to update your scripts!
`effmass` is a [peer-reviewed](https://joss.theoj.org/papers/10.21105/joss.00797) Python (3.6+) package for calculating various definitions of effective mass from the electronic bandstructure of a semiconducting material. It consists of a core `Segment` class that calculates the effective mass and other associated properties of selected bandstructure segments. The programme also contains functions for locating bandstructure extrema, constructing segments and plotting approximations to the dispersion. There is a command line interface for calculating parabolic effective mass values, and an API for the more complex, non-parabolic definitions of effective mass.
If you use `effmass` for your published research [please cite accordingly](#citing-effmass).
## What's new?
💃 `effmass` now has more options for locating extrema of a particular type: by direction or band type (conduction/valence/frontier). There are updated usage examples in the [tutorial](https://nbviewer.jupyter.org/github/lucydot/effmass/blob/master/tutorials/Tutorial.ipynb).
💃 `effmass` now interfaces with more codes:
- it can read in Castep output data (in addition to Vasp and FHI-aims)
- it can work with ASE bandstructure objects
- it can work with Octopus output files
💃 `effmass` now includes a command line interface
As a result of these changes, and with view to supporting more DFT codes in the future, the `Data` class has been renamed to `DataVasp` ⚠️ **On updating to the latest version of effmass you may need to update your scripts / Jupyter Notebook to reflect this change** ⚠️
## Features
`effmass` can:
**Read in a bandstructure:**
It is assumed you have used a DFT calculator to walk through a 1D slice of the Brillouin Zone, capturing the maxima and minima of interest. `effmass` uses the Python package [vasppy](https://github.com/bjmorgan/vasppy) for parsing `VASP` output.
**Locate extrema:**
These correspond to the valence band maxima and conduction band minima. Maxima and minima within a certain energy range can also be located.
**Calculate curvature, transport and optical effective masses:**
The curvature (aka inertial) and transport masses are calculated using the derivatives of a fitted polynomial function. The optical effective mass can also be calculated assuming a Kane dispersion.
**Assess the extent of non-parabolicity:**
Parameters of the Kane quasi-linear dispersion are calculated to quantify the extent of non-parabolicity over a given energy range.
**Calculate the quasi-fermi level for a given carrier concentration:**
Using density-of-states data and assuming no thermal smearing, `effmass` can calculate the energy to which states are occupied. This is a useful approximation to the quasi-Fermi level. *Note: this is only supported for VASP and requires the output file `DOSCAR`.*
**Plot fits to the dispersion:**
Selected bandstructure segments and approximations to the dispersion (assuming a Kane, quadratic, or higher order fit) can be visualised.
Depending on the functionality and level of approximation you are looking for,
it may be that one of the packages listed [here](https://effmass.readthedocs.io/en/latest/Related%20packages.html) will suit your needs better.
## Supported Codes
`effmass` currently supports `VASP`, `FHI-Aims`, `Castep`, `ASE`, and `Octopus`. In the near future we hope to play nicely with other codes that interface with the ASE bandstructure class, and pymatgen. We especially welcome contributions that will help make `effmass` available to more researchers.
## Other effective mass codes
There are other codes that can calculate effective mass. The best effective mass code depends on your use case.
- You may find [Sumo bandstats](https://smtg-ucl.github.io/sumo/sumo-bandstats.html) easier to use if you are looking for a basic parabolic fit.
- [Amset](https://github.com/hackingmaterials/amset) can be used to calculate the effective mass across the whole Brillouin Zone (useful if your CBM/VBM is not at a high symmetry point, for example). Further details can be found on MatSci discussion forum [here](https://matsci.org/t/effective-mass/3585/9)
You may find that someone else has already calculated the effective mass you need - there are 10,000's DFT-calculated effective mass values on MPContribs [here](https://contribs.materialsproject.org/projects/carrier_transport).
## Installation
`effmass` can be installed using the Python package manager `pip`:
```
pip install effmass
```
If you use conda/anaconda, the safest thing to do is to create a new environment and then install effmass:
```
conda create -n effmass python
conda activate effmass
pip install effmass
```
If you wish, you can install the very latest version of `effmass` from GitHub with the commands below. **Note**: The latest GitHub version may include more features and data format support that the latest release, but it is not a stable release, so may have more issues than usual. If you are unsure, use one of the above install methods instead.
```
git clone https://github.com/lucydot/effmass.git
cd effmass
pip install .
```
## Command Line Interface
The [command line interface](#Installation) provides basic functionality for calculating parabolic effective masses.
For those who have a basic familiarity with Python there is an API which provides access to all features, including non-parabolic effective mass definitions.
To start the command line interface simply type
```
effmass
```
and follow the prompts. You are asked if you would like to print a plot of the segments found - we recommend that you do this, to check that the segments are "sensible". You are also asked if you would like to print a summary file - again, we recommend that you do this, so that you have a record of the CLI options chosen.
## Documentation
- An overview of the features of effmass, along with example code for Vasp and FHI-aims output data, is contained in a Jupyter notebook [here](https://nbviewer.jupyter.org/github/lucydot/effmass/blob/master/tutorials/Tutorial.ipynb).
- Additional Jupyter notebook examples for the Castep and ASE interfaces are [here](https://nbviewer.jupyter.org/github/lucydot/effmass/blob/master/tutorials/Castep_ASE_interface.ipynb).
- The API documentation is [here](https://effmass.readthedocs.io/en/latest/).
- Further details about the various effective mass definitions implemented in `effmass` can be found in Phys. Rev. B **99** (8), 085207, which is also [available on arXiv](https://arxiv.org/pdf/1811.02281.pdf).
- The source code is available as a git repository at [https://github.com/lucydot/effmass](https://github.com/lucydot/effmass).
### Running notebook examples
If you want to run the jupyter notebook examples/tutorials you will also need to install `notebook`:
```
pip install notebook
```
To run the notebook, run the following command at the Terminal (Mac/Linux) or Command Prompt (Windows):
```
jupyter notebook
```
This will open a web browser tab, which you can use to navigate to the notebook examples.
## Publications using `effmass`
A [number of publications](https://scholar.google.co.uk/scholar?oi=bibs&hl=en&cites=12032412581356217625) have used `effmass`.
`effmass` was initially developed for a project that has been published as *Impact of nonparabolic electronic band structure on the optical and transport properties of photovoltaic materials* Phys. Rev. B **99** (8), 085207. This paper is also [avaiable on arXiv](https://arxiv.org/pdf/1811.02281.pdf). The [paper directory](https://github.com/lucydot/effmass/paper) contains the Vasp input data (POSCAR), Vasp output data (OUTCAR/PROCAR) and band structures generated for this study.
## Questions, bug reports, feature requests
Please use the Github [issue tracker](https://github.com/lucydot/effmass/issues/) for any questions, feature requests or bug reports. Please do not contact the developers via email unless there is a specific reason you do not want the conversation to be public. If we do not respond within a reasonable timeframe, then please feel free to reach out to Lucy via email; Github notifications have a nasty habit of getting lost.
## Development
If you would like to contribute please do so via a pull request. All contributors must read and respect the [code of conduct](https://github.com/lucydot/effmass/blob/master/CODE_OF_CONDUCT.md). In particular, we welcome contributions which would extend `effmass` so that it is able to parse output from other electronic structure codes.
### Version numbers
For versioning we are following the guidelines [here](https://carpentries-incubator.github.io/python_packaging/instructor/05-publishing.html#extra-consistent-versioning-with-setuptools-scm). This allows automatic versioning according to the latest tag on Github.
### Test PYPI
When testing a build on the test PYPI site it is important to point to the actual PYPI for the dependencies..its a *GOTCHA*...
```pip install -i https://pypi.org/pypi/ --extra-index-url https://test.pypi.org/simple effmass==2.3.4.dev3```
## Tests
Automated testing of the latest commit happens [here](https://app.travis-ci.com/github/lucydot/effmass).
You can also run tests locally:
```
pip install effmass[tests]
cd effmass
python -m pytest
```
## Citing `effmass`
If you use this code in your research, please cite the following paper:
Whalley, Lucy D. (2018). *effmass - an effective mass package*. The Journal of Open Source Software, 3(28) 797.
Link to paper [here](https://joss.theoj.org/papers/10.21105/joss.00797).
### Bibtex
```
@misc{Whalley_JOSS2018,
author = {Lucy D. Whalley},
title = {effmass: An effective mass package},
volume = {3},
issue = {28},
pages = {797},
month = {Aug},
year = {2018},
doi = {10.21105/joss.00797},
url = {http://joss.theoj.org/papers/10.21105/joss.00797}
}
```
## Contributors
Lead developer:
[Lucy Whalley](https://lucydot.github.io), a.k.a [lucydot](https://github.com/lucydot)
Contributors:
Eisuke Kawashima (tests), a.k.a [e-kwsm](https://github.com/e-kwsm) //
Florian Knoop (bugs, tweaks and script improvements), a.k.a [flokno](https://github.com/flokno) //
William Taylor (auto-versioning and build system requirements), a.k.a [musicmrman99](https://github.com/musicmrman99) //
Austin Fatt (support for Ocotpus), a.k.a [afatt](https://github.com/afatt) //
Matthias Goloumb (Support for FHI-Aims), a.k.a [MatthiasGolomb](https://github.com/MatthiasGolomb) //
Katarina Brlec (Support for vasprun files) a.k.a [brlec](https://github.com/brlec) //
Sean Kavanagh (Documentation), a.k.a [kavanase](https://github.com/kavanase) //
Benjamin Morgan (Vasppy compatability), a.k.a [bjmorgan](https://github.com/bjmorgan) //