Metadata-Version: 2.4
Name: ad_hoc_diffractometer
Version: 0.11.0
Summary: Describe any multi-circle diffractometer geometry and perform X-ray/neutron crystallography calculations.
Project-URL: Homepage, https://github.com/BCDA-APS/ad_hoc_diffractometer
Project-URL: Documentation, https://BCDA-APS.github.io/ad_hoc_diffractometer/latest
Project-URL: Source, https://github.com/BCDA-APS/ad_hoc_diffractometer
Project-URL: Issues, https://github.com/BCDA-APS/ad_hoc_diffractometer/issues
Author-email: Pete Jemian <prjemian+ad_hoc@gmail.com>
Maintainer-email: Pete Jemian <prjemian+ad_hoc@gmail.com>
License-Expression: LicenseRef-ANL-Open-Source-License
License-File: LICENSE
Keywords: crystallography,diffraction,geometry,neutron,x-ray
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: numpy
Requires-Dist: pyyaml
Provides-Extra: all
Requires-Dist: hatch-vcs; extra == 'all'
Requires-Dist: matplotlib; extra == 'all'
Requires-Dist: myst-nb; extra == 'all'
Requires-Dist: pydata-sphinx-theme; extra == 'all'
Requires-Dist: pytest; extra == 'all'
Requires-Dist: pytest-cov; extra == 'all'
Requires-Dist: scipy; extra == 'all'
Requires-Dist: sphinx; extra == 'all'
Requires-Dist: sphinx-autoapi; extra == 'all'
Requires-Dist: sphinx-copybutton; extra == 'all'
Requires-Dist: sphinx-design; extra == 'all'
Requires-Dist: sphinx-tabs; extra == 'all'
Provides-Extra: dev
Requires-Dist: hatch-vcs; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: scipy; extra == 'dev'
Provides-Extra: doc
Requires-Dist: matplotlib; extra == 'doc'
Requires-Dist: myst-nb; extra == 'doc'
Requires-Dist: pydata-sphinx-theme; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-autoapi; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-design; extra == 'doc'
Requires-Dist: sphinx-tabs; extra == 'doc'
Description-Content-Type: text/markdown

# *Ad hoc* diffractometer

[![Release](https://img.shields.io/github/v/release/bcda-aps/ad_hoc_diffractometer)](https://github.com/bcda-aps/ad_hoc_diffractometer/releases)
[![Tag](https://img.shields.io/github/v/tag/bcda-aps/ad_hoc_diffractometer)](https://github.com/bcda-aps/ad_hoc_diffractometer/tags)
[![PyPi](https://img.shields.io/pypi/v/ad_hoc_diffractometer.svg)](https://pypi.python.org/pypi/ad_hoc_diffractometer)
[![Conda Package](https://img.shields.io/badge/package-ad_hoc_diffractometer-green.svg)](https://anaconda.org/channels/conda-forge/packages/ad-hoc-diffractometer/overview)
[![Conda Version](https://anaconda.org/conda-forge/ad-hoc-diffractometer/badges/version.svg)](https://anaconda.org/channels/conda-forge/packages/ad-hoc-diffractometer/overview)
[![Conda Downloads](https://anaconda.org/conda-forge/ad-hoc-diffractometer/badges/downloads.svg)](https://anaconda.org/channels/conda-forge/packages/ad-hoc-diffractometer/overview)
[![Conda Platforms](https://anaconda.org/conda-forge/ad-hoc-diffractometer/badges/platforms.svg)](https://anaconda.org/channels/conda-forge/packages/ad-hoc-diffractometer/overview)
[![Coverage Status](https://coveralls.io/repos/github/bcda-aps/ad_hoc_diffractometer/badge.svg?branch=main)](https://coveralls.io/github/bcda-aps/ad_hoc_diffractometer?branch=main)
[![Documentation](https://img.shields.io/badge/docs-blue)](https://bcda-aps.github.io/ad_hoc_diffractometer/)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/bcda-aps/ad_hoc_diffractometer)
[![License: ANL](https://img.shields.io/badge/license-ANL-brightgreen)](LICENSE)

`ad_hoc_diffractometer` is a Python package that lets you describe any
multi-circle diffractometer geometry and perform X-ray/neutron
crystallography calculations.

See the [**Quick Start
guide**](https://BCDA-APS.github.io/ad_hoc_diffractometer/latest/quick_start.html)
for a step-by-step walkthrough building an Eulerian four-circle geometry
— choosing a coordinate basis, stage stacking, diffraction mode
definition(s), and running a forward calculation. Common geometries are
provided as examples.

<table>

  <tr>
    <td><a href="https://BCDA-APS.github.io/ad_hoc_diffractometer/latest/install.html">
    <b>Get started</b>
    <br />
    Install the package and verify the installation.
    </a></td>
    <td><a href="https://BCDA-APS.github.io/ad_hoc_diffractometer/latest/user_guide.html">
    <b>User Guide</b>
    <br />
    Concepts, how-to guides, and demonstration geometries.
    </a></td>
  </tr>

  <tr>
    <td><a href="https://BCDA-APS.github.io/ad_hoc_diffractometer/latest/about.html">
    <b>About ...</b>
    <br />
    Features, requirements, use cases, ...
    </a></td>
    <td><a href="https://BCDA-APS.github.io/ad_hoc_diffractometer/latest/references.html">
    <b>References</b>
    <br />
    All literature citations — geometry papers, physical constants, and numerical methods.
    </a></td>
  </tr>

</table>
