Skip to content

Commit e8fb1a5

Browse files
author
Martin D. Weinberg
committed
Doc string updates only [no CI]
1 parent 020b521 commit e8fb1a5

3 files changed

Lines changed: 14 additions & 2 deletions

File tree

expui/BiorthBasis.H

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -948,8 +948,12 @@ namespace BasisClasses
948948
};
949949

950950
/**
951-
Uses EmpCylSL basis to evaluate expansion coeffients and provide
951+
@brief Uses EmpCylSL basis to evaluate expansion coeffients and provide
952952
potential and density basis fields
953+
954+
@note The HDF5 disk basis cache is gzip compressed by default to
955+
save disk space. The user may turn off compression using the
956+
`compress: 0` parameter, although we have no particular use case.
953957
*/
954958
class Cylindrical : public BiorthBasis
955959
{

pyEXP/BasisWrappers.cc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,10 @@ void BasisFactoryClasses(py::module &m)
8787
or with the same basis used on previous pyEXP invocations. At this
8888
point, you must create the YAML configuration for the basis even if
8989
the basis is cached. This is a safety and consistency feature that
90-
may be relaxed in a future version.
90+
may be relaxed in a future version. The HDF5 disk basis cache is
91+
gzip compressed by default to save disk space. The user may turn off
92+
compression using the `compress: 0` parameter, although we have no
93+
particular use case.
9194
9295
Coefficient creation
9396
--------------------

src/Cylinder.H

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,11 @@ class MixtureBasis;
122122
123123
@param dumpbasis set to true dumps the basis to a file for
124124
diagnostic examination (default: false)
125+
126+
@param compress sets the HDF5 cache file compression level. The
127+
HDF5 disk basis cache is gzip compressed by default at compress=5
128+
to save disk space. The user may turn off compression usin the
129+
compress=0, although we have no particular use case.
125130
*/
126131
class Cylinder : public Basis
127132
{

0 commit comments

Comments
 (0)