.. _installation:
************
Installation
************
There are several different ways to install the `asdf` package. Each is
described in detail below.
Requirements
============
The `asdf` package has several dependencies which are listed in the project's
setup.cfg file. All dependencies are available on pypi and will be automatically
installed along with `asdf`.
Support for units, time, and transform tags requires an implementation of these
types. One recommended option is the `astropy `__ package.
Optional support for `lz4 `__
compression is provided by the `lz4 `__ package.
Installing with pip
===================
.. include:: ../../README.rst
:start-after: begin-pip-install-text:
:end-before: begin-source-install-text:
Installing with conda
=====================
`asdf` is also distributed as a `conda `__ package via
the `conda-forge `__ channel. It is also available
through the `astroconda `__
channel.
To install `asdf` within an existing conda environment::
$ conda install -c conda-forge asdf
To create a new conda environment and install `asdf`::
$ conda create -n new-env-name -c conda-forge python asdf
Building from source
====================
.. include:: ../../README.rst
:start-after: begin-source-install-text:
:end-before: end-source-install-text:
Running the tests
=================
.. include:: ../../README.rst
:start-after: begin-testing-text:
:end-before: end-testing-text: