Smaller shared functions for use by other diffpy packages.
- LONGER DESCRIPTION HERE
For more information about the diffpy.utils library, see the users manual.
The preferred method is to use Miniconda Python 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.utils
conda create -n diffpy.utils python=3 conda activate diffpy.utils
Then, to fully install diffpy.utils in our active environment, run
conda install diffpy.utils
Another option is to use pip to download and install the latest release from
Python Package Index.
To install using pip into your diffpy.utils environment, we will also have to install dependencies
pip install -r https://raw.githubusercontent.com/diffpy/diffpy.utils/main/requirements/run.txt
and then install the package
pip install diffpy.utils
If you prefer to install from sources, after installing the dependencies, obtain the source archive from
GitHub. Once installed, cd into your diffpy.utils directory
and run the following
pip install .
Diffpy user group is the discussion forum for general questions and discussions about the use of diffpy.utils. You can join the diffpy.utils users community by joining the Google group. The diffpy.utils project welcomes your expertise and enthusiasm!
If you see a bug or want to request a feature, please report it as an issue and/or submit a fix as a PR. You can also post it to the Diffpy user group.
Feel free to fork the project and contribute. To install diffpy.utils 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 .
Improvements and fixes are always appreciated.
To learn more about how to successfully get involved and contributing to diffpy.utils, please see our Contributing guide and Code of Conduct.
For more information on diffpy.utils please visit the project web-page or email Prof. Simon Billinge at sb2896@columbia.edu.
If you use diffpy.utils in a scientific publication, we would appreciate citations [ADD LINK].