Skip to content

Latest commit

 

History

History
284 lines (188 loc) · 10.6 KB

install.rst

File metadata and controls

284 lines (188 loc) · 10.6 KB
Raw

Installation

Installing astropy

If you are new to Python and/or do not have familiarity with Python virtual environments, then we recommend starting by installing the Anaconda Distribution. This works on all platforms (linux, Mac, Windows) and installs a full-featured scientific Python in a user directory without requiring root permissions.

Using pip

Warning

Users of the Anaconda Python distribution should follow the instructions for :ref:`anaconda_install`.

To install astropy with |pip|, run:

python -m pip install astropy

If you want to make sure none of your existing dependencies get upgraded, you can also do:

python -m pip install astropy --no-deps

On the other hand, if you want to install astropy along with recommended or even all of the available optional :ref:`dependencies <astropy-main-req>`, you can do:

python -m pip install "astropy[recommended]"

or:

python -m pip install "astropy[all]"

In most cases, this will install a pre-compiled version (called a wheel) of astropy, but if you are using a very recent version of Python, if a new version of astropy has just been released, or if you are building astropy for a platform that is not common, astropy will be installed from a source file. Note that in this case you will need a C compiler to be installed (see Building from source below) for the installation to succeed.

If you get a PermissionError this means that you do not have the required administrative access to install new packages to your Python installation. In this case you should first create and activate a Python environment using either :ref:`Conda <anaconda_install>` or a Python virtual environment. Both of these options will also allow you to do development on other software that uses astropy, such as an affiliated package.

Warning

Do not install astropy or other third-party packages using sudo.

Using Conda

To install astropy using conda run:

conda install astropy

astropy is installed by default with the Anaconda Distribution. To update to the latest version run:

conda update astropy

There may be a delay of a day or two between when a new version of astropy is released and when a package is available for conda. You can check for the list of available versions with conda search astropy.

If you want to install astropy along with recommended or all of the available optional :ref:`dependencies <astropy-main-req>`, you can do:

conda install --channel conda-forge --channel defaults scipy matplotlib

or:

conda install --channel conda-forge --channel defaults scipy matplotlib \
  h5py beautifulsoup4 html5lib bleach pandas sortedcontainers \
  pytz setuptools mpmath bottleneck jplephem asdf-astropy pyarrow

To also be able to run tests (see below) and support :ref:`builddocs` use the following. We use pip for these packages to ensure getting the latest releases which are compatible with the latest pytest and sphinx releases:

python -m pip install pytest-astropy sphinx-astropy

Warning

Attempting to use pip to upgrade your installation of astropy itself may result in a corrupted installation.

Testing an Installed astropy

See the documentation on how to test your installed version of astropy.

Requirements

astropy has the following strict requirements:

astropy also depends on a number of other packages for optional features. The following are particularly recommended:

The further dependencies provide more specific features:

However, note that these packages require installation only if those particular features are needed. astropy will import even if these dependencies are not installed.

The following packages can optionally be used when testing:

Building from Source

If you want to build the code from source, follow the instructions for :ref:`contributing_environment`. Note that instead of cloning from your fork, you can choose to clone from the main repository:

git clone https://github.com/astropy/astropy.git
cd astropy

Building the documentation is typically not necessary unless you are developing code or documentation or do not have internet access, because the stable, latest, and archived versions of Astropy's documentation are available at docs.astropy.org . The process is described in Building the Documentation from Source.

Testing a Source Code Build of astropy

{% if is_development %}

The easiest way to run the tests in a source checkout of astropy is to use tox:

tox -e test-alldeps

There are also alternative methods of :ref:`running-tests` if you would like more control over the testing process.

{%else%}

See the latest documentation on how to run the tests in a source checkout of astropy.

{%endif%}

Installing pre-built Development Versions of astropy

Most nights a development snapshot of astropy will be compiled. This is useful if you want to test against a development version of astropy but do not want to have to build it yourselves. You can see the available astropy dev snapshots page to find out what is currently being offered.

Installing these "nightlies" of astropy can be achieved by using pip:

python -m pip install --upgrade --extra-index-url https://pypi.anaconda.org/astropy/simple astropy --pre

The extra index URL tells pip to check the pip index on pypi.anaconda.org, where the nightlies are stored, and the --pre command tells pip to install pre-release versions (in this case .dev releases).

You can test this installation by running the tests as described in the section Running tests on an installed astropy.