:py:mod:`solar` =============== .. py:module:: solar .. autoapi-nested-parse:: This gives graphical views of the Sun's position relative to that of the given source. Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: solar.Celpos solar.intList solar.Source_Obs Functions ~~~~~~~~~ .. autoapisummary:: solar.arg_init solar.observer solar.build_fixed_body solar.unlink_wrap solar.get_rise_set solar.get_polygons solar.get_polygons_angrange_vis solar.get_polygons_angrange solar.plot_vis_solar solar.main Attributes ~~~~~~~~~~ .. autoapisummary:: solar.HELP_START solar.catalogue solar.DEFAULT_SUN_LIMITS solar.explanation solar.announce .. py:data:: HELP_START :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """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 """ .. raw:: html
.. py:data:: catalogue .. py:data:: DEFAULT_SUN_LIMITS :value: [0.0, 4.0, 40.0, 90.0, 130.0] .. py:data:: explanation .. py:data:: announce :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ solar.py """ .. raw:: html
.. py:function:: arg_init() Define the interprestation of command line arguments. .. py:class:: Celpos(option_strings, dest, nargs=None, **kwargs) Bases: :py:obj:`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. .. py:method:: __call__(parser, namespace, values, option_string=None) .. py:class:: intList(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None) Bases: :py:obj:`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. .. py:method:: __call__(parser, namespace, values, option_string=None) .. py:function:: observer(horizon='15.0') .. py:function:: build_fixed_body(ra, dec) .. py:class:: Source_Obs(src_name, src_pos) Bases: :py:obj:`object` .. py:method:: set_date(date) .. py:function:: unlink_wrap(dat, lims=None, thresh=0.95) 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`. .. py:function:: get_rise_set(s_obs) .. py:function:: get_polygons(data, **kwargs_poly) .. py:function:: get_polygons_angrange_vis(data, angrng, **kwargs_poly) .. py:function:: get_polygons_angrange(data, angrng, **kwargs_poly) .. py:function:: plot_vis_solar(s_obs, data, sun_limits=None, show_solar_labels=False) .. py:function:: main()