Skip to content

Commit

Permalink
Add positiion_fast_and_accurate and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
taldcroft committed Nov 25, 2023
1 parent 674bf7a commit 5eaf31a
Show file tree
Hide file tree
Showing 3 changed files with 294 additions and 125 deletions.
11 changes: 6 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
import sys

sys.path.insert(0, os.path.abspath('..'))
from Ska.Sun import __version__
from ska_sun import __version__

# -- General configuration ------------------------------------------------

Expand All @@ -35,7 +35,8 @@
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.githubpages',
'sphinx.ext.mathjax',
'sphinx.ext.viewcode']
'sphinx.ext.viewcode',
'numpydoc']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -50,7 +51,7 @@
master_doc = 'index'

# General information about the project.
project = 'Ska.Sun'
project = 'ska_sun'
copyright = '2020, Tom Aldcroft'
author = 'Tom Aldcroft'

Expand All @@ -68,7 +69,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down Expand Up @@ -106,7 +107,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# html_static_path = ['_static']

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down
17 changes: 15 additions & 2 deletions ska_sun/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,21 @@ class Conf(ConfigNamespace):
"""

sun_position_method_default = ConfigItem(
["fast", "accurate"],
'Default value of `method` parameter in ska_sun.position() (default="fast").',
["fast_and_accurate", "fast", "accurate"],
"Default value of `method` parameter in ska_sun.position()"
' (default="fast_and_accurate").',
)

fast_and_accurate_pitch_limit = ConfigItem(
165.0,
"Pitch value above which the accurate method is used for "
"ska_sun.pitch() and ska_sun.off_nom_roll() when method='fast_and_accurate'.",
)

from_chandra_default = ConfigItem(
False,
"Default value of `from_chandra` parameter in ska_sun.position_accurate() "
"(default=False).",
)


Expand Down
Loading

0 comments on commit 5eaf31a

Please sign in to comment.