# Installation

The easiest way to install transientNamer is to use `pip` (here we show the install inside of a conda environment):

``` bash
conda create -n transientNamer python=3.7 pip
conda activate transientNamer
pip install transientNamer
```

Or you can clone the [github repo](https://github.com/thespacedoctor/transientNamer) and install from a local version of the code:

``` bash
git clone git@github.com:thespacedoctor/transientNamer.git
cd transientNamer
python setup.py install
```

To upgrade to the latest version of transientNamer use the command:

``` bash
pip install transientNamer --upgrade
```

To check installation was successful run `transientNamer -v`. This should return the version number of the install.

## MySQL

If you wish to make use of the tools that allow interaction with a MySQL database you have to have [MySQL](https://www.mysql.com/)/[Maria DB](https://mariadb.org/) server installed and access to a database. Credentials to the database are to be added to the settings file (see [`initialisation`](../initialisation.md)).

You also need to install PyMySQL into your conda environment via:

``` bash
conda install pymysql
```

## Development

If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

``` bash
git clone git@github.com:thespacedoctor/transientNamer.git
cd transientNamer
python setup.py develop
```

[Pull requests](https://github.com/thespacedoctor/transientNamer/pulls) are welcomed! 

<!-- ### Sublime Snippets

If you use [Sublime Text](https://www.sublimetext.com/) as your code editor, and you're planning to develop your own python code with soxspipe, you might find [my Sublime Snippets](https://github.com/thespacedoctor/transientNamer-Sublime-Snippets) useful. -->