Skip to content

Commit 104aab3

Browse files
committed
update pyproject.toml for optional packages, confirm #260 is complete
1 parent a123ce4 commit 104aab3

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

docs/source/packages.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,6 +254,13 @@ optional packages are:
254254
integration into Windows. Conda provides this under the name
255255
pywin32.
256256

257+
* zarr: The zarr package is used to read and write compressed
258+
hierarchical files. It is used by the APS MIDAS program to produce
259+
files of integrated powder diffraction patterns.
260+
261+
* sympy: This package performs symbolic computations and is used
262+
for k-vector searching with ISODISTORT.
263+
257264
*Conda command*:
258265
Should you wish to install Python and the desired packages yourself,
259266
this is certainly possible. For Linux, ``apt`` or ``yum`` is an option, as is
@@ -316,7 +323,8 @@ additional packages are installed:
316323
* Pillow (https://pillow.readthedocs.org) and/or
317324
* h5py (requires hdf5). Used to read HDF5 files.
318325
* pybaselines: for auto-background (https://github.com/derb12/pybaselines)
319-
* xmltodict: for Bruker BRML files.
326+
* xmltodict: for reading Bruker BRML files.
327+
* zarr: reading powder data files produced MIDAS (APS)
320328
* seekpath: for k-vector searching
321329

322330
but none of these are required to run scripts and the vast

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,13 @@ useful = [ # recommended but not required
5555
"requests",
5656
"pillow",
5757
"h5py",
58-
"hdf5",
5958
"imageio",
6059
"pybaselines",
6160
"xmltodict",
6261
"seekpath",
6362
"gitpython",
63+
"zarr",
64+
"sympy"
6465
]
6566

6667
self-install = [ # for self-installation of optional software

0 commit comments

Comments
 (0)