Metadata-Version: 2.1
Name: dials-data
Version: 2.4.19
Summary: DIALS Regression Data Manager
Home-page: https://github.com/dials/data
Author: DIALS development team
Author-email: dials-support@lists.sourceforge.net
License: BSD 3-Clause License
Project-URL: Bug Tracker, https://github.com/dials/data/issues
Project-URL: Documentation, https://dials-data.readthedocs.io/
Project-URL: Source Code, https://github.com/dials/data
Keywords: dials,dials_data
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
License-File: LICENSE

=============================
DIALS Regression Data Manager
=============================

.. image:: https://img.shields.io/pypi/v/dials_data.svg
        :target: https://pypi.python.org/pypi/dials_data
        :alt: PyPI release

.. image:: https://img.shields.io/conda/vn/conda-forge/dials-data.svg
        :target: https://anaconda.org/conda-forge/dials-data
        :alt: Conda release

.. image:: https://travis-ci.com/dials/data.svg?branch=master
        :target: https://travis-ci.com/dials/data
        :alt: Build status

.. image:: https://img.shields.io/lgtm/grade/python/g/dials/data.svg?logo=lgtm&logoWidth=18
        :target: https://lgtm.com/projects/g/dials/data/context:python
        :alt: Language grade: Python

.. image:: https://img.shields.io/lgtm/alerts/g/dials/data.svg?logo=lgtm&logoWidth=18
        :target: https://lgtm.com/projects/g/dials/data/alerts/
        :alt: Total alerts

.. image:: https://readthedocs.org/projects/dials-data/badge/?version=latest
        :target: https://dials-data.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation status

.. image:: https://img.shields.io/pypi/pyversions/dials_data.svg
        :target: https://pypi.org/project/dials_data/
        :alt: Supported Python versions

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
        :target: https://github.com/ambv/black
        :alt: Code style: black

.. image:: https://img.shields.io/pypi/l/dials_data.svg
        :target: https://pypi.python.org/pypi/dials_data
        :alt: BSD license

A python package providing data files used for regression tests in
DIALS_, dxtbx_, xia2_ and related packages.

If you want to know more about what ``dials-data`` is you can
have a read through the `background information <https://dials-data.readthedocs.io/en/latest/why.html>`__.

For everything else `the main documentation <https://dials-data.readthedocs.io/>`__ is probably the best start.


Installation
^^^^^^^^^^^^

To install this package in a normal Python environment, run::

    pip install dials-data

and then you can use it with::

    dials.data

If you are in a conda environment you can instead run::

    conda install -c conda-forge dials-data

For more details please take a look at the
`installation and usage page <https://dials-data.readthedocs.io/en/latest/installation.html>`__.


.. _DIALS: https://dials.github.io
.. _dxtbx: https://github.com/cctbx/cctbx_project/tree/master/dxtbx
.. _xia2: https://xia2.github.io

=======
History
=======

2.5 (????-??-??)
^^^^^^^^^^^^^^^^


2.4 (2022-03-07)
^^^^^^^^^^^^^^^^

* dials_data no longer uses ``py.path`` internally.
* dials_data now includes type checking with mypy.
* We started using the ``requests`` library for faster downloads.
* Downloads now happen in parallel.

2.3 (2022-01-11)
^^^^^^^^^^^^^^^^

* Drop Python 3.6 compatibility
* Dataset `SSX_CuNiR_processed` has been renamed to `cunir_serial_processed` for consistency
  with `cunir_serial`

2.2 (2021-06-18)
^^^^^^^^^^^^^^^^

* Deprecate the use of ``py.path`` as test fixture return type.
  You can either silence the warning by specifying ``dials_data("dataset", pathlib=False)``
  or move to the new ``pathlib.Path`` return objects by setting ``pathlib=True``.
  This deprecation is planned to be in place for a considerable amount of time.
  In the next major release (3.0) the default return type will become ``pathlib.Path``,
  with ``py.path`` still available if ``pathlib=False`` is specified. At this point
  the ``pathlib=`` argument will be deprecated.
  In the following minor release (3.1) all support for ``py.path`` will be dropped.

2.1 (2020-06-11)
^^^^^^^^^^^^^^^^

* Drops Python 2.7 compatibility
* Uses importlib.resources to access resource files (requires Python 3.9 or installed package importlib_resources)

2.0 (2019-04-15)
^^^^^^^^^^^^^^^^

* Convert dials_data to a pytest plugin

1.0 (2019-02-16)
^^^^^^^^^^^^^^^^

* Add functions for forward-compatibility
* Enable new release process including automatic deployment of updates

0.6 (2019-02-15)
^^^^^^^^^^^^^^^^

* Added datasets blend_tutorial, thaumatin_i04

0.5 (2019-01-24)
^^^^^^^^^^^^^^^^

* Added documentation
* Added datasets fumarase, vmxi_thaumatin

0.4 (2019-01-11)
^^^^^^^^^^^^^^^^

* Beta release
* Added datasets insulin, pychef
* Automated generation of hashinfo files via Travis


0.3 (2019-01-09)
^^^^^^^^^^^^^^^^

* Dataset download mechanism
* Added dataset x4wide


0.2 (2019-01-08)
^^^^^^^^^^^^^^^^

* Alpha release
* Basic command line interface
* pytest fixture


0.1 (2018-11-02)
^^^^^^^^^^^^^^^^

* First automatic deployment and release on PyPI


