<commit_before>Getting started
===============

Requirements
------------

poliastro requires the following Python packages:

* NumPy, for basic numerical routines
* Astropy, for physical units and time handling
* numba (optional), for accelerating the code
* jplephem, for the planetary ephemerides using SPICE kernels
* matplotlib, for orbit plotting
* scipy, for root finding and numerical propagation
* pytest, for running the tests from the package

poliastro is usually tested on Linux, Windows and OS X on Python
3.5 and 3.6 against latest NumPy.

Installation
------------

The easiest and fastest way to get the package up and running is to
install poliastro using `conda <https://conda.io/docs/>`_::

  $ conda install poliastro --channel conda-forge

.. note::

    We encourage users to use conda and the
    `conda-forge <https://conda-forge.org/>`_ packages for convenience,
    especially when developing on Windows.

If the installation fails for any reason, please open an issue in the
`issue tracker`_.

Alternative installation methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you don't want to use conda you can `install poliastro from PyPI`_
using pip::

  $ pip install numpy  # Run this one first!
  $ pip install poliastro

.. warning::

    At the time of writing, this installation process requires
    a development version of SciPy to succeed on Windows.
    To install it, please check out this link:

    https://mail.python.org/pipermail/scipy-dev/2017-August/022050.html

    The complete command would be::

        $ pip install --pre poliastro -f https://7933911d6844c6c53a7d-47bd50c35cd79bd838daf386af554a83.ssl.cf2.rackcdn.com/

    If these installation steps fail for you, please consider using conda.

Finally, you can also install the latest development version of poliastro
`directly from GitHub`_::

  $ pip install https://github.com/poliastro/poliastro/archive/master.zip

This is useful if there is some feature that you want to try, but we did not
release it yet as a stable version. Although you might find some unpolished
details, these development installations should work without problems. If
you find any, please open an issue in the `issue tracker`_.

.. _`install poliastro from PyPI`: https://pypi.python.org/pypi/poliastro/
.. _`directly from GitHub`: http://github.com/poliastro/poliastro

.. warning::

    It is recommended that you **never ever use sudo** with distutils, pip,
    setuptools and friends in Linux because you might seriously break your
    system [1_][2_][3_][4_]. Options are `per user directories`_, `virtualenv`_
    or `local installations`_.

.. _1: http://wiki.python.org/moin/CheeseShopTutorial#Distutils_Installation
.. _2: http://stackoverflow.com/questions/4314376/how-can-i-install-a-python-egg-file/4314446#comment4690673_4314446<commit_msg>Remove special instructions for installing SciPy<commit_after>Getting started
===============

Requirements
------------

poliastro requires the following Python packages:

* NumPy, for basic numerical routines
* Astropy, for physical units and time handling
* numba (optional), for accelerating the code
* jplephem, for the planetary ephemerides using SPICE kernels
* matplotlib, for orbit plotting
* scipy, for root finding and numerical propagation
* pytest, for running the tests from the package

poliastro is usually tested on Linux, Windows and OS X on Python
3.5 and 3.6 against latest NumPy.

Installation
------------

The easiest and fastest way to get the package up and running is to
install poliastro using `conda <https://conda.io/docs/>`_::

  $ conda install poliastro --channel conda-forge

.. note::

    We encourage users to use conda and the
    `conda-forge <https://conda-forge.org/>`_ packages for convenience,
    especially when developing on Windows.

If the installation fails for any reason, please open an issue in the
`issue tracker`_.

Alternative installation methods
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you don't want to use conda you can `install poliastro from PyPI`_
using pip::

  $ pip install numpy  # Run this one first!
  $ pip install poliastro

Finally, you can also install the latest development version of poliastro
`directly from GitHub`_::

  $ pip install https://github.com/poliastro/poliastro/archive/master.zip

This is useful if there is some feature that you want to try, but we did not
release it yet as a stable version. Although you might find some unpolished
details, these development installations should work without problems. If
you find any, please open an issue in the `issue tracker`_.

.. _`install poliastro from PyPI`: https://pypi.python.org/pypi/poliastro/
.. _`directly from GitHub`: http://github.com/poliastro/poliastro

.. warning::

    It is recommended that you **never ever use sudo** with distutils, pip,
    setuptools and friends in Linux because you might seriously break your
    system [1_][2_][3_][4_]. Options are `per user directories`_, `virtualenv`_
    or `local installations`_.

.. _1: http://wiki.python.org/moin/CheeseShopTutorial#Distutils_Installation
.. _2: http://stackoverflow.com/questions/4314376/how-can-i-install-a-python-egg-file/4314446#comment4690673_4314446
{'fraction_non_alphanumeric': 0.10148276526092817, 'fraction_numerical': 0.02330059695744271, 'mean_word_length': 4.0623781676413255, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 10, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4915210', 'n_tokens_mistral': 1582, 'n_tokens_neox': 1439, 'n_words': 602}