lucydot/effmass

============
Installation
============

`effmass` is a Python 3 package and requires key packages from the `SciPy ecosystem <https://www.scipy.org/about.html>`_: SciPy, NumPy and Matplotlib. If you have not installed these packages before, it may be best to install them using your preferred package manager (eg: Homebrew). Note that together they will use >100MB of disk space. `effmass` can then be built using the Python package manager `pip`:


.. code-block:: none

   pip install effmass

To start the command line interface simply type

.. code-block:: none

    effmass

To download and install the latest release from `GitHub <https://github.com/lucydot/effmass/releases>`_

.. code-block:: none

   cd effmass
   python3 setup.py install

Or clone the latest development version

.. code-block:: none

   git clone git@github.com:lucydot/effmass.git

and install the same way.

.. code-block:: none

   cd effmass
   python3 setup.py install