karllark / DIRTY_dustrt

DIRTY: 3D dust radiative transfer for dusty astrophysical sources
https://dirty-dustrt.readthedocs.io
5 stars 1 forks source link

Fixing incorrect documentation for reading arbitrary files #30

Closed karllark closed 6 months ago

karllark commented 6 months ago

The docs stated the PAR_GRID should be set to 1 for the main grid. It should be 0. In addition, the 1st subdivided grid should have an index of 1, so a value of -1 in the main grid cell. This was incorrectly set to 2 and -2 in the docs. This PR corrects the docs.

In addition, the output from the optional subdivide overdense cells routine has been enhanced to make it clear what this subroutine is doing and reporting. And the checking of reading arbitrary grids from FITS files has been enhanced to check the parent grid index is correct. Finally, some of the files have been reformatted to make the indentation clearer.

Thanks to @hvbish and @catherinezucker for pointing out the error in the docs.