diffpy.srxconfutils 1.0.3
Configuration utilities for project. Part of xPDFsuite
Requires Python: <3.15,>=3.11
Keywords: diffpy, pdf, data interpretation

|Icon| |title|_
===============

.. |title| replace:: diffpy.srxconfutils
.. _title: https://diffpy.github.io/diffpy.srxconfutils

.. |Icon| image:: https://avatars.githubusercontent.com/diffpy
        :target: https://diffpy.github.io/diffpy.srxconfutils
        :height: 100px

|PyPI| |Forge| |PythonVersion| |PR|

|CI| |Codecov| |Black| |Tracking|

.. |Black| image:: https://img.shields.io/badge/code_style-black-black
        :target: https://github.com/psf/black

.. |CI| image:: https://github.com/diffpy/diffpy.srxconfutils/actions/workflows/matrix-and-codecov-on-merge-to-main.yml/badge.svg
        :target: https://github.com/diffpy/diffpy.srxconfutils/actions/workflows/matrix-and-codecov-on-merge-to-main.yml

.. |Codecov| image:: https://codecov.io/gh/diffpy/diffpy.srxconfutils/branch/main/graph/badge.svg
        :target: https://codecov.io/gh/diffpy/diffpy.srxconfutils

.. |Forge| image:: https://img.shields.io/conda/vn/conda-forge/diffpy.srxconfutils
        :target: https://anaconda.org/conda-forge/diffpy.srxconfutils

.. |PR| image:: https://img.shields.io/badge/PR-Welcome-29ab47ff
        :target: https://github.com/diffpy/diffpy.srxconfutils/pulls

.. |PyPI| image:: https://img.shields.io/pypi/v/diffpy.srxconfutils
        :target: https://pypi.org/project/diffpy.srxconfutils/

.. |PythonVersion| image:: https://img.shields.io/pypi/pyversions/diffpy.srxconfutils
        :target: https://pypi.org/project/diffpy.srxconfutils/

.. |Tracking| image:: https://img.shields.io/badge/issue_tracking-github-blue
        :target: https://github.com/diffpy/diffpy.srxconfutils/issues

Configuration utilities for diffpy project. Part of xPDFsuite.

Citation
--------

If you use diffpy.srxconfutils in a scientific publication, we would like you to cite this package as

        Xiaohao Yang, Pavol Juhas, Christopher L. Farrow and Simon J. L. Billinge, xPDFsuite: an end-to-end
        software solution for high throughput pair distribution function transformation, visualization and
        analysis, arXiv 1402.3163 (2014)

Installation
------------

The preferred method is to use `Miniconda Python
<https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html>`_
and install from the "conda-forge" channel of Conda packages.

To add "conda-forge" to the conda channels, run the following in a terminal. ::

        conda config --add channels conda-forge

We want to install our packages in a suitable conda environment.
The following creates and activates a new environment named ``diffpy.srxconfutils_env`` ::

        conda create -n diffpy.srxconfutils_env diffpy.srxconfutils
        conda activate diffpy.srxconfutils_env

The output should print the latest version displayed on the badges above.

If the above does not work, you can use ``pip`` to download and install the latest release from
`Python Package Index <https://pypi.python.org>`_.
To install using ``pip`` into your ``diffpy.srxconfutils_env`` environment, type ::

        pip install diffpy.srxconfutils

If you prefer to install from sources, after installing the dependencies, obtain the source archive from
`GitHub <https://github.com/diffpy/diffpy.srxconfutils/>`_. Once installed, ``cd`` into your ``diffpy.srxconfutils`` directory
and run the following ::

        pip install .

This package also provides command-line utilities. To check the software has been installed correctly, type ::

        diffpy.srxconfutils --version

You can also type the following command to verify the installation. ::

        python -c "import diffpy.srxconfutils; print(diffpy.srxconfutils.__version__)"


To view the basic usage and available commands, type ::

        diffpy.srxconfutils -h

Getting Started
---------------

You may consult our `online documentation <https://diffpy.github.io/diffpy.srxconfutils>`_ for tutorials and API references.

Support and Contribute
----------------------

If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.srxconfutils/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.srxconfutils/pulls>`_.

Feel free to fork the project and contribute. To install diffpy.srxconfutils
in a development mode, with its sources being directly used by Python
rather than copied to a package directory, use the following in the root
directory ::

        pip install -e .

To ensure code quality and to prevent accidental commits into the default branch, please set up the use of our pre-commit
hooks.

1. Install pre-commit in your working environment by running ``conda install pre-commit``.

2. Initialize pre-commit (one time only) ``pre-commit install``.

Thereafter your code will be linted by black and isort and checked against flake8 before you can commit.
If it fails by black or isort, just rerun and it should pass (black and isort will modify the files so should
pass after they are modified). If the flake8 test fails please see the error messages and fix them manually before
trying to commit again.

Improvements and fixes are always appreciated.

Before contributing, please read our `Code of Conduct <https://github.com/diffpy/diffpy.srxconfutils/blob/main/CODE-OF-CONDUCT.rst>`_.

Contact
-------

For more information on diffpy.srxconfutils please visit the project `web-page <https://diffpy.github.io/>`_ or email Simon J.L. Billinge group at sb2896@columbia.edu.

Acknowledgements
----------------

``diffpy.srxconfutils`` is built and maintained with `scikit-package <https://scikit-package.github.io/scikit-package/>`_.