Installation¶

Installing with pip¶

These instructions cover installation with the pip package management tool. This will install dmsky and its dependencies into your python distribution.

Before starting the installation process, you will need to determine whether you have setuptools and pip installed in your local python environment.

$ curl https://bootstrap.pypa.io/get-pip.py | python -

Check if pip is correctly installed:

$ which pip

Once again, if this isn’t the pip in your python environment something went wrong. Now install dmsky by running:

$ pip install dmsky

To run the ipython notebook examples you will also need to install jupyter notebook:

$ pip install jupyter

Finally, check that dmsky imports:

$ python
Python 2.7.8 (default, Aug 20 2015, 11:36:15)
[GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.56)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import dmsky
>>> dmsky.__file__

The instructions describe how to install development versions of Dmsky. Before installing a development version we recommend first installing a tagged release following the Installing with pip instructions above.

The development version of Dmsky can be installed by running pip install with the URL of the git repository:

$ pip install git+https://github.com/fermiPy/dmsky.git

This will install the most recent commit on the master branch. Note that care should be taken when using development versions as features/APIs under active development may change in subsequent versions without notice.

Upgrading¶

By default installing dmsky with pip or conda will get the latest tagged released available on the PyPi package respository. You can check your currently installed version of dmsky with pip show:

$ pip show dmsky

To upgrade your dmsky installation to the latest version run the pip installation command with --upgrade --no-deps (remember to also include the --user option if you’re running at SLAC):

$ pip install dmsky --upgrade --no-deps
Collecting dmsky
Installing collected packages: dmsky
  Found existing installation: dmsky 0.2.0
    Uninstalling dmsky-0.2.0:
      Successfully uninstalled dmsky-0.2.0
Successfully installed dmsky-0.2.1

Developer Installation¶

These instructions describe how to install dmsky from its git source code repository using the setup.py script. Installing from source can be useful if you want to make your own modifications to the dmsky source code. Note that non-developers are recommended to install a tagged release of dmsky following the Installing with pip or instructions above.

First clone the dmsky git repository and cd to the root directory of the repository:

$ git clone https://github.com/fermiPy/dmsky.git
$ cd dmsky

To install the latest commit in the master branch run setup.py install from the root directory:

# Install the latest commit
$ git checkout master
$ python setup.py install --user

A useful option if you are doing active code development is to install your working copy of the package. This will create an installation in your python distribution that is linked to the copy of the code in your local repository. This allows you to run with any local modifications without having to reinstall the package each time you make a change. To install your working copy of dmsky run with the develop argument:

# Install a link to your source code installation
$ python setup.py develop --user

You can later remove the link to your working copy by running the same command with the --uninstall flag:

# Install a link to your source code installation
$ python setup.py develop --user --uninstall

Specific release tags can be installed by running git checkout before running the installation command:

# Checkout a specific release tag
$ git checkout X.X.X
$ python setup.py install --user

To see the list of available release tags run git tag.

Issues¶

If you get an error about importing matplotlib (specifically something about the macosx backend) you might change your default backend to get it working. The customizing matplotlib page details the instructions to modify your default matplotlibrc file (you can pick GTK or WX as an alternative). Specifically the TkAgg and macosx backends currently do not work on OSX if you upgrade matplotlib to the version required by dmsky. To get around this issue you can switch to the Agg backend at runtime before importing dmsky:

>>> import matplotlib
>>> matplotlib.use('Agg')

However note that this backend does not support interactive plotting.

If you are running OSX El Capitan or newer you may see errors like the following:

dyld: Library not loaded

In this case you will need to disable the System Integrity Protections (SIP). See here for instructions on disabling SIP on your machine.