From 4df51c3986f9dd987257ba710663e511c14adb3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Ne=C4=8Dada?= Date: Wed, 25 May 2022 06:09:31 +0300 Subject: [PATCH] BaseSpec constructor docs --- qpms/cybspec.pyx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/qpms/cybspec.pyx b/qpms/cybspec.pyx index 9983272..866c440 100644 --- a/qpms/cybspec.pyx +++ b/qpms/cybspec.pyx @@ -35,6 +35,13 @@ cdef class BaseSpec: whenever used in other wrapper classes that need the pointer to qpms_vswf_set_spec_t, remember to set a (private, probably immutable) reference to qpms.basespec to ensure correct reference counting and garbage collection. + + BaseSpec can be constructed either using a single keyword argument `lMax` to include + all the transversal vector spherical wavefunction to a specific degree, or + using an explicit list of integer basis VSWF codes, \see qpms_uvswfi_t + BaseSpec(lMax = ) + or + BaseSpec([ uvswfi0, ... ]) ''' #cdef qpms_vswf_set_spec_t s # in pxd #cdef np.ndarray __ilist # in pxd