This package includes plugins that provide ASDF serialization support for astropy objects. The plugins are automatically enabled when the package is installed.
The plugins in this package supersede those in the astropy.io.misc.asdf
module;
when this package is installed, the astropy plugins will be ignored. The
astropy.io.misc.asdf
module will be removed in a future version of astropy.
This project is Copyright (c) Association of Universities for Research in Astronomy (AURA) and licensed under the terms of the BSD 3-Clause license. This package is based upon the Astropy package template which is licensed under the BSD 3-clause license. See the licenses folder for more information.
Stable releases of the asdf-astropy python package are registered at
PyPi. The latest stable version
can be installed using pip
:
$ pip install asdf-astropy
The latest development version of asdf-astropy is available from the main
branch
on github. To clone the project:
$ git clone https://github.com/astropy/asdf-astropy
To install:
$ cd asdf-astropy
$ pip install .
To install in development mode
$ pip install -e .
To install the test dependencies from a source checkout of the repository:
$ pip install -e ".[test]"
To run the unit tests from a source checkout of the repository:
$ pytest
It is also possible to run the test suite from an installed version of the package.
$ pip install "asdf-astropy[test]"
$ pytest --pyargs asdf-astropy
It is also possible to run the tests using tox.
$ pip install tox
To list all available environments:
$ tox -va
To run a specific environment:
$ tox -e <envname>
We love contributions! asdf-astropy is open source, built on open source, and we'd love to have you hang out in our community.