<commit_before>.. _installation:

============
Installation
============

Installing pylinac is easy no matter your skill! However, no matter your skill level,
please take a look at the note below Dependencies to avoid some initial frustration.
Determine where you're at and then read the relevant section:

I know Python already
---------------------

Great! To get started, simply install pylinac via PyPI::

    pip install pylinac

Alternatively, you can install from the github repository directly::

    pip install https://github.com/jrkerns/pylinac.git

Finally, you can download the repo (from github) and run ``setup.py install`` in the root directory

I'm new to Python
-----------------

That's okay! If you're not a programmer at all you'll have a few things to do to get up and running,
but never fear. Using pylinac requires not just the base language Python, but a few dependencies as well (see below). If you're new to
programming or come from, say MATLAB, you probably want to use an Integrated Development Environment (IDE). Unlike MATLAB,
you have a choice in IDEs when using Python; in fact the choices are numerous! Two that are worth considering are `PyCharm <https://www.jetbrains.com/pycharm/>`_
and `Spyder <https://code.google.com/p/spyderlib/>`_, both of which are *free*. An
easy way to get all of this in one lump sum is to download a distribution "stack", which includes Python and a number of other packages
(see note below for options).

.. note::
    If you're new to Python or you don't already have the packages listed below
    it is often best to get these from a source that has already compiled these packages. Installing them via ``pip`` won't work unless
    you have the underlying libraries and compilers installed, which is often not the case. There are a number of places you can get them
    pre-compiled. Check out `Scipy's installation options <http://www.scipy.org/install.html>`_ for more on scientific distribution stacks. For
    people new to Python, the easiest solution is likely `Python(x,y) <https://code.google.com/p/pythonxy/>`_ (Windows only) or
    `Anaconda <http://continuum.io/downloads>`_. Both include the `Spyder IDE <https://bitbucket.org/spyder-ide/spyderlib/overview>`_,
    which appears similar to MATLAB's. Installing one of those will have you up and running in no time.<commit_msg>updated installation from github instructions<commit_after>.. _installation:

============
Installation
============

Installing pylinac is easy no matter your skill! However, no matter your skill level,
please take a look at the note below Dependencies to avoid some initial frustration.
Determine where you're at and then read the relevant section:

I know Python already
---------------------

Great! To get started, simply install pylinac via PyPI::

    pip install pylinac

Alternatively, you can install from the github repository directly::

    pip install https://github.com/jrkerns/pylinac/zipball/master

If you run into issues be sure to upgrade pip all the way ``pip install pip --upgrade``, then retry.

Finally, you can download the repo (from github) and run ``setup.py install`` in the root directory

I'm new to Python
-----------------

That's okay! If you're not a programmer at all you'll have a few things to do to get up and running,
but never fear. Using pylinac requires not just the base language Python, but a few dependencies as well (see below). If you're new to
programming or come from, say MATLAB, you probably want to use an Integrated Development Environment (IDE). Unlike MATLAB,
you have a choice in IDEs when using Python; in fact the choices are numerous! Two that are worth considering are `PyCharm <https://www.jetbrains.com/pycharm/>`_
and `Spyder <https://code.google.com/p/spyderlib/>`_, both of which are *free*. An
easy way to get all of this in one lump sum is to download a distribution "stack", which includes Python and a number of other packages
(see note below for options).

.. note::
    If you're new to Python or you don't already have the packages listed below
    it is often best to get these from a source that has already compiled these packages. Installing them via ``pip`` won't work unless
    you have the underlying libraries and compilers installed, which is often not the case. There are a number of places you can get them
    pre-compiled. Check out `Scipy's installation options <http://www.scipy.org/install.html>`_ for more on scientific distribution stacks. For
    people new to Python, the easiest solution is likely `Python(x,y) <https://code.google.com/p/pythonxy/>`_ (Windows only) or
    `Anaconda <http://continuum.io/downloads>`_. Both include the `Spyder IDE <https://bitbucket.org/spyder-ide/spyderlib/overview>`_,
    which appears similar to MATLAB's. Installing one of those will have you up and running in no time.
{'fraction_non_alphanumeric': 0.0932290594772587, 'fraction_numerical': 0.0, 'mean_word_length': 3.894259818731118, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 8, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5601981', 'n_tokens_mistral': 1328, 'n_tokens_neox': 1246, 'n_words': 684}