.. _quickinstall:

=============
Quick install
=============

..   Install Anaconda python
..   =======================
..     
..   ``irfpy`` is optimally designed under Anaconda Python package
..   running on MacOSX or Linux.
..   
..   .. note::
..   
..         Definitivaly ``irfpy`` works with any python packages, but
..         ``irfpy`` development team cannot support installation
..         and setup to such packages (as long as Anaconda Python is working).

..   .. note::
..   
..       So far ``irfpy`` development team does not have resources
..       to support Windows.  For Windows user, it is worthwhile to
..       consider using ``VirtualBox`` or equivalent to install Linux system.
..     
..   1. Download the Anaconda Python from https://www.continuum.io/downloads.
..   2. Install Anaconda Python following the instruction (e.g. http://conda.pydata.org/docs/install/quick.html).
..   3. It is recommended to exercise "30 minute test drive" for conda (http://conda.pydata.org/docs/test-drive.html).

Install ``irfpy.cpem``
================================================================

Installation is simple; use pip, the python package manager.

.. code-block:: sh

        % pip install --find-links=https://irfpy.irf.se/sdist irfpy.cpem

Update ``irfpy.cpem``
================================================================

Since ``irfpy`` is updating as frequently as possible, you may sometimes
want to update the package.
But don't worry, it is enough simple.  Add "-U" in the end of the ``pip``.

.. code-block:: sh

        % pip install --find-links=https://irfpy.irf.se/sdist irfpy.cpem -U

Uninstall ``irfpy.cpem``
========================

If you want to uninstall the package, just pip uninstall command.

.. code-block:: sh

        % pip uninstall irfpy.cpem


Troubleshoot
============

Let's see if the installation works correctly.

1. Open a terminal

2. Then start ipython.

.. code-block:: sh

        ipython

If it is successful, a prompt ``In [1]:`` is seen.

3. Try importing several important packages, as seen examples below.

.. code-block:: py

        import irfpy.cpem                   # irfpy.cpem module

If fails, the corresponding package is not installed correctly.