.. _macro_lightning-installation:

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

|Code Size|

************
With ``pip``
************

.. container::

	|PyPI| |PyPI Format|

*macro_lightning* requires `Astropy <https://www.astropy.org>`_ as a pre-requisite, for package configuration.

The easiest way to get *macro_lightning* is to install with `pip <https://pypi.org/project/macro_lightning/>`_. To install with pip::

    pip install macro_lightning


***********
From source
***********

To install the latest version, or from a branch, *macro_lightning* can be installed from `source <https://github.com/cwru-pat/macro_lightning.git>`_.

From the command line.
::

	cd folder/in/which/to/install

	git clone https://github.com/cwru-pat/macro_lightning.git

	cd macro_lightning

	python setup.py install



.. |PyPI| image:: https://badge.fury.io/py/macro_lightning.svg
   :target: https://badge.fury.io/py/macro_lightning

.. |PyPI Format| image:: https://img.shields.io/pypi/format/macro_lightning?style=flat
   :alt: PyPI - Format

.. |Code Size| image:: https://img.shields.io/github/languages/code-size/cwru-pat/macro_lightning?style=flat
   :alt: GitHub code size in bytes