Skip to main content

The KinMS (KINematic Molecular Simulation) package can be used to simulate observations of arbitary molecular/atomic cold gas distributions.

Project description

Documentation Status Python 3.6 PyPI version ASCL

The KinMS (KINematic Molecular Simulation) package can be used to simulate observations of arbitary molecular/atomic cold gas distributions. The routines are written with flexibility in mind, and have been used in various different applications, including investigating the kinematics of molecular gas in early-type galaxies (Davis et al, MNRAS, Volume 429, Issue 1, p.534-555, 2013), and determining supermassive black-hole masses from CO interfermetric observations (Davis et al., Nature, 2013). They are also useful for creating input datacubes for further simulation in e.g. CASA's sim_observe tool.

Install

KinMSpy is designed with Python users in mind. Lots of work has gone into making it lightweight and fast. You can use it in the same way that you would use NumPy or Astropy etc. You can install KinMS with pip install kinms. Alternatively you can download the code, navigate to the directory you unpack it too, and run python setup.py install.

It requires the following modules:

  • numpy
  • matplotlib
  • scipy
  • astropy

Documentation

A simple iPython notebook tutorial on the basics of KinMS can be found here: KinMS simple tutorial

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

from kinms.examples.KinMS_testsuite import *
run_tests()

To get you started fitting observations with KinMS, see the walk through here: Example fitting tutorial

NEW! If you want a really simple way to fit observations, check out the new KinMS_fitter, which wraps KinMS and automates many tasks for you! Check it out here: KinMS_fitter.

Upgrading from version 1

Unlike previous generations of KinMS, version 2.0+ uses Python classes for a more modular and adjustable experience. Plotting routines can be changed and cube modelling can be probed at different stages if required. The main change you will need if upgrading from version 1.0 is to change all calls to KinMS(...) to KinMS(...).model_cube(). The tutorial notebooks above have full details of the new features.

New non-circular motions capability

As of version 2.2.0 KinMS now has the capability to model lopsided and bisymmetric gas flows, in addition to the pure radial motions included previously. To get started with this you need to add from kinms.radial_motion import radial_motion, and then pass one of the new methods to KinMS with the radial_motion_func keyword. radial_motion.lopsided_flow and radial_motion.bisymmetric_flow both take four arguments (a radial vector, the transverse and radial velocity as a function of that radius, and an angle for the perterbation). radial_motion.pure_radial replicates previous funcationality, and requires two arguments (a radius vector, and a vector for the radial velocity as a function of radius). E.g. if previously you were passing inflowVel=inflowVel then this would now equate to radial_motion_func=radial_motion.pure_radial(radius,inflowVel).

Communication

If you find any bugs, or wish to be kept up to date when new versions of this software are released, please raise an issue here on github, or email us at DavisT -at- cardiff.ac.uk, Zabelnj -at- cardiff.ac.uk, Dawsonj5 -at- cardiff.ac.uk

License

KinMSpy is MIT-style licensed, as found in the LICENSE file.

Many thanks,

Dr Timothy A. Davis, Nikki Zabel, and James M. Dawson

Cardiff, UK

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kinms-2.2.9.tar.gz (26.5 kB view hashes)

Uploaded source

Built Distribution

kinms-2.2.9-py3-none-any.whl (26.4 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page