# Installation

## PyPI

Versioned releases of AFMReader are available on the [Python Package Index (PyPI)](https://pypi.org/) and can be
installed, ideally in a virtual environment, using the following [pip](https://pip.pypa.io/en/stable/) command.

``` shell
pip install AFMReader
```

## Development

Alternatively you can install the latest development release can be installed directly from GitHub using
[pip](https://pip.pypa.io/en/stable/topics/vcs-support/ )

``` shell
pip install git+https://github.com/AFM-SPM/AFMReader.git
```

As per the documentation you can install specific commits, branches or tagged releases in this manner by appending
`@<commit>`, `@<branch>` or `@<tag>`. Please refer to the [`pip`
documentation](https://pip.pypa.io/en/stable/topics/vcs-support/ ) for further details.