gh-504: deprecate old generator functions

[ntessore]

Deprecates the old random field generator functions in favour or glass.generate(). Internally, reimplements all old functionality in terms of the new functions, and removes the dependency on the gaussiancl package.

Still a draft as I want to check that the examples don't change under the reimplementation, before also updating them to use the new functions.

Closes: #504

[ntessore]

Sphinx error doesn't happen for me locally 😞

[ntessore]

Marking as ready so examples are built, but not ready.

[ntessore]

Apparently, sphinx-autodoc-typehints is broken: tox-dev/sphinx-autodoc-typehints#523

[paddyroddy]

Apparently, sphinx-autodoc-typehints is broken: tox-dev/sphinx-autodoc-typehints#523

Was literally just about to send that too

[Saransh-cpp]

I'll take over this PR.

[Saransh-cpp]

@paddyroddy this should be ready now!

[Saransh-cpp]

Should this be deprecated before removal?

[ntessore]

This isn't public API, it was exported by mistake.

[paddyroddy]

@paddyroddy this should be ready now!

Can't render the notebook diffs

[paddyroddy]

and removes the dependency on the gaussiancl package.

and introduces transformcl dependency

[paddyroddy]

and introduces transformcl dependency

Although having a look gaussiancl depends on it anyway

[paddyroddy]

Have run and diffed things locally. Looks good to me.

[paddyroddy]

Why get rid of the docstring? Just because its internal doesn't mean it shouldn't have one

[Saransh-cpp]

Maybe @ntessore can answer this better, but the docstring was moved to generate in another PR -

glass/glass/fields.py

Lines 773 to 817 in 84dff24

	def generate(
	fields: Fields,
	gls: Cls,
	nside: int,
	*,
	ncorr: int | None = None,
	rng: np.random.Generator | None = None,
	) -> Iterator[NDArray[Any]]:
	"""
	Sample random fields from Gaussian angular power spectra.
	Iteratively sample HEALPix maps of transformed Gaussian random
	fields with the given angular power spectra *gls* and resolution
	parameter *nside*.
	The random fields are sampled from Gaussian random fields using the
	transformations in *fields*.
	The *gls* array must contain the angular power power spectra of the
	Gaussian random fields in :ref:`standard order <twopoint_order>`.
	The optional number *ncorr* limits how many realised fields are
	correlated. This saves memory, as only *ncorr* previous fields are
	kept.
	Parameters
	----------
	fields
	Transformations for the random fields.
	gls
	Gaussian angular power spectra.
	nside
	Resolution parameter for the HEALPix maps.
	ncorr
	Number of correlated fields. If not given, all fields are
	correlated.
	rng
	Random number generator. If not given, a default RNG is used.
	Yields
	------
	x
	Sampled random fields.
	"""

I wouldn't mind having it repeated (given that they are not identical) here.

[paddyroddy]

Yes I spotted it had moved

[Saransh-cpp]

Have added the docstring back. Let me know if this should be removed.