File tree Expand file tree Collapse file tree 1 file changed +8
-0
lines changed
Expand file tree Collapse file tree 1 file changed +8
-0
lines changed Original file line number Diff line number Diff line change @@ -508,6 +508,14 @@ class RealGalaxyCatalog:
508508 GalSim knows the location of the installation share directory, so it will automatically
509509 look for it there.
510510
511+ .. note::
512+
513+ A RealGalaxyCatalog instance will cache data from the input files that it loads.
514+ Normally, this leads to a performance improvement, especially if objects are selected
515+ from the catalog semi-randomly, since it is faster to access the data in memory.
516+ If you want to free the cached memory before the RealGalaxyCatalog goes out of
517+ scope, you can use the `close` method to do so.
518+
511519 Parameters:
512520 file_name: The file containing the catalog. [default: None, which will look for the
513521 F814W<25.2 COSMOS catalog in $PREFIX/share/galsim. It will raise an
You can’t perform that action at this time.
0 commit comments