Installation and Tutorial

KinMS is designed with Python users in mind, and is hopefully easy to install and use. For most use cases you will want to follow the directions under “Normal User”. If you are a power-user who wants to do something out of the ordinary then follow the “Power User” instructions. Both user types have tutorials available (see below).

Normal User

If you are a new user, and/or you don’t expect to need any advanced features then you will want the KinMS_fitter package. This installs the base KinMS routines, and wraps them in a user-friendly way to get you fitting datacubes in the minimum possible time.


KinMS_fitter can be installed with pip install kinms-fitter. Alternatively, you can download the code from GitHub, navigate to the directory you unpack it too, and run python install.


An iPython notebook tutorial on KinMS_fitter can be found here: KinMS_fitter tutorial

Power User

If you are a power user then you may just want the base KinMS routines without the fitter, in order to roll your own analysis code. Note- if you already installed the fitter then there is no need to install KinMS separately- you already have everything you need to follow the tutorials below.


KinMS can be installed with pip install kinms. Alternatively you can download the code from GitHub, navigate to the directory you unpack it too, and run python install.


To understand the basics of the base KinMS routines a tutorial can be found here: KinMS simple tutorial

A further suite of examples can be found in examples/, which can be modified and updated for most use cases. To run these tests you can run the following commands from within python on KinMS is installed:

from kinms.examples.KinMS_testsuite import *

If you need go through the nuts and bolts of fitting, see the walk through here: Example fitting tutorial

Bugs and further assistance

If you find any bugs while using KinMS, or have feature requests, please either raise an issue on the respective github, or contact me directly. Similarly, I am very happy to assist with all aspects of using KinMS- feel free to get in touch!

Mailing List

Once you have KinMS installed and working you may wish to join the mailing list, so you can be kept up to date with major releases and bugs. Simply contact me - you will never be spammed, or your details sold!

(Go Back)