Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some minor RTD fixes #115

Merged
merged 1 commit into from
Dec 6, 2024
Merged

Some minor RTD fixes #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@


extensions = [
'sphinx.ext.todo',
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
'sphinx.ext.intersphinx',
Expand Down
4 changes: 2 additions & 2 deletions scopesim_templates/extragalactic/galaxies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,8 +340,8 @@ def elliptical(r_eff, pixel_scale, filter_name, amplitude,
- an EmissionCurve with a user defined spectrum


Optional Parameters (passed to ``sersic_profile``)
--------------------------------------------------
Other Parameters
----------------
n : float, optional
Default = 4. Sersic index
- n=1 for exponential (spiral),
Expand Down
9 changes: 5 additions & 4 deletions scopesim_templates/misc/misc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def source_from_imagehdu(image_hdu, filter_name, pixel_unit_amplitude=None,
... filter_name=filter_name,
... pixel_unit_amplitude=20*u.Jy)

TODO: Check if the image_hdu has WCS
.. todo:: Check if the image_hdu has WCS
"""
if filter_name is None and waverange is None:
raise ValueError("Wavelength information must be given with either a "
Expand Down Expand Up @@ -351,7 +351,7 @@ def source_from_file(filename, pixel_scale, sed, amplitude, filter_curve,
"""
Create a source from a fits image.

TODO: Pass the header (or the WCS) to the source object
.. todo:: Pass the header (or the WCS) to the source object

Parameters
----------
Expand Down Expand Up @@ -388,8 +388,9 @@ def source_from_cube(cube, ext=1) -> Source:
In the future more checks will be performed to translate most cubes into a
suitable format.

TODO: Set the cube to a different flux level and different pixel scales.
Redshift the cube
.. todo::
Set the cube to a different flux level and different pixel scales.
Redshift the cube

Parameters
----------
Expand Down
8 changes: 4 additions & 4 deletions scopesim_templates/stellar/clusters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ def cluster(mass=1E3, distance=50000, core_radius=1, ra=RA0, dec=DEC0,
Generate a source object for a young cluster.

The cluster distribution follows a gaussian profile with the
``core_radius`` corresponding to the HWHM of the distribution. The
`core_radius` corresponding to the HWHM of the distribution. The
choice of stars follows a Kroupa IMF, with no evolved stars in the mix.
Ergo this is more suitable for a young cluster than an evolved custer
Ergo this is more suitable for a young cluster than an evolved cluster


Parameters
Expand All @@ -42,8 +42,8 @@ def cluster(mass=1E3, distance=50000, core_radius=1, ra=RA0, dec=DEC0,
dec : float, str
DEC of the source

Additional parameters
---------------------
Other Parameters
----------------
tidal_radius : float
[pc] Not yet implemented, for later once there is a King profile
multiplicity : Unknown
Expand Down
Loading