-
Notifications
You must be signed in to change notification settings - Fork 24
Installation
The simplest way to install RM-tools is to download the source code and install it using pip. This will ensure the core dependencies are satisfied and will set up the command line tools. The latest official release of RM-Tools is available on PyPi and can be installed directly with pip: pip install RM-Tools.
If you wish to install the most recent version, the code can be downloaded here. To install: unzip the code, open a terminal and navigate to the unzipped directory, and execute: pip install -e .
Not all aspects of RM-Tools are directly callable from the command line or conveniently accessible through import statements. It is recommended to find where RM-Tools is installed (or to directly install it to a convenient directly) so that these additional scripts can be accessed.
If you do not have pip, but do have the setuptools package, you can install RM-tools similarly by navigating to the unzipped folder and running the following command python setup.py build install
If you do not wish to install the package into your Python installation, the code can be run by directly calling the top level programs (e.g., python RMtools_1D/do_RMsynth_1D.py -h), but it is likely that some functions will not import properly unless the RM-tools directory is added to the Python path.
RM-tools requires Python 3.5 or greater, and the following packages:
numpy
scipy
matplotlib
astropy
If QU-fitting is going to be used, pymultinest is also required. Installation instructions for pymultinest can be found here.
If parallelization of RM-clean is going to be used, schwimmbad is required. Installation instructions can be found here