# Initialisation 

Before using transientNamer you need to use the `init` command to generate a user settings file. Running the following creates a [yaml](https://learnxinyminutes.com/docs/yaml/) settings file in your home folder under `~/.config/transientNamer/transientNamer.yaml`:

```bash
transientNamer init
```

The file is initially populated with transientNamer's default settings which can be adjusted to your preference.

If at any point the user settings file becomes corrupted or you just want to start afresh, simply trash the `transientNamer.yaml` file and rerun `transientNamer init`.

## Modifying the Settings

Once created, open the settings file in any text editor and make any modifications needed. For example:

```yaml
database settings:
    db: myDB
    host: localhost
    user: dbuser
    password: dbpass

astronote-cache: ~/Desktop/astronotes

# FIND IN YOUR USER ACCOUNT SETTING ON TNS : https://www.wis-tns.org
user-agent: 'tns_marker{"XXXX"}'
```

You will need to register to the TNS to get a unique `tns-marker` from your account settings on <https://www.wis-tns.org>. Once you have the `tns-marker` add it to your settings file.

## Basic Python Setup

If you plan to use `transientNamer` in your own scripts you will first need to parse your settings file and set up logging etc. One quick way to do this is to use the `fundamentals` package to give you a logger, a settings dictionary and a database connection (if connection details given in settings file):

```python
## SOME BASIC SETUP FOR LOGGING, SETTINGS ETC
from fundamentals import tools
from os.path import expanduser
home = expanduser("~")
settingsFile  = home + "/.config/transientNamer/transientNamer.yaml"
su = tools(
    arguments={"settingsFile": settingsFile},
    docString=__doc__,
)
arguments, settings, log, dbConn = su.setup()
```