solar

This gives graphical views of the Sun’s position relative to that of the given source.

Module Contents

Classes

Celpos

Information about how to convert command line strings to Python objects.

intList

Information about how to convert command line strings to Python objects.

Source_Obs

Functions

arg_init()

Define the interprestation of command line arguments.

observer([horizon])

build_fixed_body(ra, dec)

unlink_wrap(dat[, lims, thresh])

Iterate over contiguous regions of dat (i.e. where it does not

get_rise_set(s_obs)

get_polygons(data, **kwargs_poly)

get_polygons_angrange_vis(data, angrng, **kwargs_poly)

get_polygons_angrange(data, angrng, **kwargs_poly)

plot_vis_solar(s_obs, data[, sun_limits, ...])

main()

Attributes

HELP_START

catalogue

DEFAULT_SUN_LIMITS

explanation

announce

solar.HELP_START = Multiline-String[source]
Show Value
"""This presents a plot of source availability and susceptibility to solar interference
as a function of day-of-year and time of day.

V 30Nov2018
"""
solar.catalogue[source]
solar.DEFAULT_SUN_LIMITS = [0.0, 4.0, 40.0, 90.0, 130.0][source]
solar.explanation[source]
solar.announce = Multiline-String[source]
Show Value
"""
solar.py
"""
solar.arg_init()[source]

Define the interprestation of command line arguments.

class solar.Celpos(option_strings, dest, nargs=None, **kwargs)[source]

Bases: argparse.Action

Information about how to convert command line strings to Python objects.

Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances.

Keyword Arguments:

  • option_strings – A list of command-line option strings which

    should be associated with this action.

  • dest – The name of the attribute to hold the created object(s)

  • nargs – The number of command-line arguments that should be

    consumed. By default, one argument will be consumed and a single value will be produced. Other values include:

    • N (an integer) consumes N arguments (and produces a list)

    • ‘?’ consumes zero or one arguments

    • ‘*’ consumes zero or more arguments (and produces a list)

    • ‘+’ consumes one or more arguments (and produces a list)

    Note that the difference between the default and nargs=1 is that with the default, a single value will be produced, while with nargs=1, a list containing a single value will be produced.

  • const – The value to be produced if the option is specified and the

    option uses an action that takes no values.

  • default – The value to be produced if the option is not specified.

  • type – A callable that accepts a single string argument, and

    returns the converted value. The standard Python types str, int, float, and complex are useful examples of such callables. If None, str is used.

  • choices – A container of values that should be allowed. If not None,

    after a command-line argument has been converted to the appropriate type, an exception will be raised if it is not a member of this collection.

  • required – True if the action must always be specified at the

    command line. This is only meaningful for optional command-line arguments.

  • help – The help string describing the argument.

  • metavar – The name to be used for the option’s argument with the

    help string. If None, the ‘dest’ value will be used as the name.

__call__(parser, namespace, values, option_string=None)[source]
class solar.intList(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)[source]

Bases: argparse.Action

Information about how to convert command line strings to Python objects.

Action objects are used by an ArgumentParser to represent the information needed to parse a single argument from one or more strings from the command line. The keyword arguments to the Action constructor are also all attributes of Action instances.

Keyword Arguments:

  • option_strings – A list of command-line option strings which

    should be associated with this action.

  • dest – The name of the attribute to hold the created object(s)

  • nargs – The number of command-line arguments that should be

    consumed. By default, one argument will be consumed and a single value will be produced. Other values include:

    • N (an integer) consumes N arguments (and produces a list)

    • ‘?’ consumes zero or one arguments

    • ‘*’ consumes zero or more arguments (and produces a list)

    • ‘+’ consumes one or more arguments (and produces a list)

    Note that the difference between the default and nargs=1 is that with the default, a single value will be produced, while with nargs=1, a list containing a single value will be produced.

  • const – The value to be produced if the option is specified and the

    option uses an action that takes no values.

  • default – The value to be produced if the option is not specified.

  • type – A callable that accepts a single string argument, and

    returns the converted value. The standard Python types str, int, float, and complex are useful examples of such callables. If None, str is used.

  • choices – A container of values that should be allowed. If not None,

    after a command-line argument has been converted to the appropriate type, an exception will be raised if it is not a member of this collection.

  • required – True if the action must always be specified at the

    command line. This is only meaningful for optional command-line arguments.

  • help – The help string describing the argument.

  • metavar – The name to be used for the option’s argument with the

    help string. If None, the ‘dest’ value will be used as the name.

__call__(parser, namespace, values, option_string=None)[source]
solar.observer(horizon='15.0')[source]
solar.build_fixed_body(ra, dec)[source]
class solar.Source_Obs(src_name, src_pos)[source]

Bases: object

set_date(date)[source]

Iterate over contiguous regions of dat (i.e. where it does not jump from near one limit to the other).

This function returns an iterator object that yields slice objects, which index the contiguous portions of dat.

This function implicitly assumes that all points in dat fall within lims.

solar.get_rise_set(s_obs)[source]
solar.get_polygons(data, **kwargs_poly)[source]
solar.get_polygons_angrange_vis(data, angrng, **kwargs_poly)[source]
solar.get_polygons_angrange(data, angrng, **kwargs_poly)[source]
solar.plot_vis_solar(s_obs, data, sun_limits=None, show_solar_labels=False)[source]
solar.main()[source]