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.

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

Add more module docstrings for API reference #114

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions scopesim_templates/extragalactic/agns.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
"""Placeolder, currently empty."""
2 changes: 2 additions & 0 deletions scopesim_templates/extragalactic/clusters.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
"""Placeolder, currently empty."""
3 changes: 2 additions & 1 deletion scopesim_templates/extragalactic/exgal_models.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
"""Module should contain analytical extragalactic models."""
# -*- coding: utf-8 -*-
"""Contains abstract models used by the galaxy functions."""

from dataclasses import dataclass
from collections.abc import Generator
Expand Down
3 changes: 2 additions & 1 deletion scopesim_templates/extragalactic/galaxies.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# -*- coding: utf-8 -*-
"""TBA."""
"""Contains several functions for simple galaxy models."""

import pathlib

import numpy as np
Expand Down
3 changes: 3 additions & 0 deletions scopesim_templates/extragalactic/galaxy_utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# -*- coding: utf-8 -*-
"""Contains an alternative function for Sersic profiles."""

import numpy as np
from astropy.modeling.models import Sersic2D

Expand Down
2 changes: 2 additions & 0 deletions scopesim_templates/extragalactic/quasars.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
"""Placeolder, currently empty."""
1 change: 1 addition & 0 deletions scopesim_templates/stellar/clusters.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# -*- coding: utf-8 -*-
"""Currently only contains a simple zero-age open cluster."""

import numpy as np
Expand Down
3 changes: 2 additions & 1 deletion scopesim_templates/stellar/imf.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# -*- coding: utf-8 -*-
"""
Initial mass function.
Initial mass function, used by the cluster function.

KL:
Copied (18.06.2020, vers:134c5ff) almost directly from
Expand Down
3 changes: 3 additions & 0 deletions scopesim_templates/stellar/stars.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# -*- coding: utf-8 -*-
"""Contains functions to create random or regular spaced point sources."""

import numpy as np
from astropy.table import Table
from astropy import units as u
Expand Down
3 changes: 3 additions & 0 deletions scopesim_templates/stellar/stars_utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# -*- coding: utf-8 -*-
"""Internal utility functions for stellar functions."""

import numpy as np
from collections.abc import Iterable

Expand Down
Loading