aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-02-19 22:10:26 +0100
committerMattias Andrée <maandree@kth.se>2021-02-19 22:10:26 +0100
commitec7baa81e8fd4bec924d6adf3ee880af621a10ba (patch)
tree700434a1a65c55584dff270ed45e4bdfd46f6ab3 /doc
parentAdd blue hour (diff)
downloadsolar-python-ec7baa81e8fd4bec924d6adf3ee880af621a10ba.tar.gz
solar-python-ec7baa81e8fd4bec924d6adf3ee880af621a10ba.tar.bz2
solar-python-ec7baa81e8fd4bec924d6adf3ee880af621a10ba.tar.xz
Imrpove makefile and flatten the hier a bit
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc')
-rw-r--r--doc/info/fdl.texinfo505
-rw-r--r--doc/info/solar-python.texinfo511
2 files changed, 0 insertions, 1016 deletions
diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo
deleted file mode 100644
index cb71f05..0000000
--- a/doc/info/fdl.texinfo
+++ /dev/null
@@ -1,505 +0,0 @@
-@c The GNU Free Documentation License.
-@center Version 1.3, 3 November 2008
-
-@c This file is intended to be included within another document,
-@c hence no sectioning command or @node.
-
-@display
-Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
-@uref{http://fsf.org/}
-
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-@end display
-
-@enumerate 0
-@item
-PREAMBLE
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document @dfn{free} in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of ``copyleft'', which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-@item
-APPLICABILITY AND DEFINITIONS
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The ``Document'', below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as ``you''. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A ``Modified Version'' of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A ``Secondary Section'' is a named appendix or a front-matter section
-of the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall
-subject (or to related matters) and contains nothing that could fall
-directly within that overall subject. (Thus, if the Document is in
-part a textbook of mathematics, a Secondary Section may not explain
-any mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The ``Invariant Sections'' are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The ``Cover Texts'' are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A ``Transparent'' copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not ``Transparent'' is called ``Opaque''.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, La@TeX{} input
-format, SGML or XML using a publicly available
-DTD, and standard-conforming simple HTML,
-PostScript or PDF designed for human modification. Examples
-of transparent image formats include PNG, XCF and
-JPG. Opaque formats include proprietary formats that can be
-read and edited only by proprietary word processors, SGML or
-XML for which the DTD and/or processing tools are
-not generally available, and the machine-generated HTML,
-PostScript or PDF produced by some word processors for
-output purposes only.
-
-The ``Title Page'' means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, ``Title Page'' means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-The ``publisher'' means any person or entity that distributes copies
-of the Document to the public.
-
-A section ``Entitled XYZ'' means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as ``Acknowledgements'',
-``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
-of such a section when you modify the Document means that it remains a
-section ``Entitled XYZ'' according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-@item
-VERBATIM COPYING
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-@item
-COPYING IN QUANTITY
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-@item
-MODIFICATIONS
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-@enumerate A
-@item
-Use in the Title Page (and on the covers, if any) a title distinct
-from that of the Document, and from those of previous versions
-(which should, if there were any, be listed in the History section
-of the Document). You may use the same title as a previous version
-if the original publisher of that version gives permission.
-
-@item
-List on the Title Page, as authors, one or more persons or entities
-responsible for authorship of the modifications in the Modified
-Version, together with at least five of the principal authors of the
-Document (all of its principal authors, if it has fewer than five),
-unless they release you from this requirement.
-
-@item
-State on the Title page the name of the publisher of the
-Modified Version, as the publisher.
-
-@item
-Preserve all the copyright notices of the Document.
-
-@item
-Add an appropriate copyright notice for your modifications
-adjacent to the other copyright notices.
-
-@item
-Include, immediately after the copyright notices, a license notice
-giving the public permission to use the Modified Version under the
-terms of this License, in the form shown in the Addendum below.
-
-@item
-Preserve in that license notice the full lists of Invariant Sections
-and required Cover Texts given in the Document's license notice.
-
-@item
-Include an unaltered copy of this License.
-
-@item
-Preserve the section Entitled ``History'', Preserve its Title, and add
-to it an item stating at least the title, year, new authors, and
-publisher of the Modified Version as given on the Title Page. If
-there is no section Entitled ``History'' in the Document, create one
-stating the title, year, authors, and publisher of the Document as
-given on its Title Page, then add an item describing the Modified
-Version as stated in the previous sentence.
-
-@item
-Preserve the network location, if any, given in the Document for
-public access to a Transparent copy of the Document, and likewise
-the network locations given in the Document for previous versions
-it was based on. These may be placed in the ``History'' section.
-You may omit a network location for a work that was published at
-least four years before the Document itself, or if the original
-publisher of the version it refers to gives permission.
-
-@item
-For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
-the Title of the section, and preserve in the section all the
-substance and tone of each of the contributor acknowledgements and/or
-dedications given therein.
-
-@item
-Preserve all the Invariant Sections of the Document,
-unaltered in their text and in their titles. Section numbers
-or the equivalent are not considered part of the section titles.
-
-@item
-Delete any section Entitled ``Endorsements''. Such a section
-may not be included in the Modified Version.
-
-@item
-Do not retitle any existing section to be Entitled ``Endorsements'' or
-to conflict in title with any Invariant Section.
-
-@item
-Preserve any Warranty Disclaimers.
-@end enumerate
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled ``Endorsements'', provided it contains
-nothing but endorsements of your Modified Version by various
-parties---for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-@item
-COMBINING DOCUMENTS
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled ``History''
-in the various original documents, forming one section Entitled
-``History''; likewise combine any sections Entitled ``Acknowledgements'',
-and any sections Entitled ``Dedications''. You must delete all
-sections Entitled ``Endorsements.''
-
-@item
-COLLECTIONS OF DOCUMENTS
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-@item
-AGGREGATION WITH INDEPENDENT WORKS
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an ``aggregate'' if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-@item
-TRANSLATION
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled ``Acknowledgements'',
-``Dedications'', or ``History'', the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-@item
-TERMINATION
-
-You may not copy, modify, sublicense, or distribute the Document
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense, or distribute it is void, and
-will automatically terminate your rights under this License.
-
-However, if you cease all violation of this License, then your license
-from a particular copyright holder is reinstated (a) provisionally,
-unless and until the copyright holder explicitly and finally
-terminates your license, and (b) permanently, if the copyright holder
-fails to notify you of the violation by some reasonable means prior to
-60 days after the cessation.
-
-Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, receipt of a copy of some or all of the same material does
-not give you any rights to use it.
-
-@item
-FUTURE REVISIONS OF THIS LICENSE
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-@uref{http://www.gnu.org/copyleft/}.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License ``or any later version'' applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation. If the Document
-specifies that a proxy can decide which future versions of this
-License can be used, that proxy's public statement of acceptance of a
-version permanently authorizes you to choose that version for the
-Document.
-
-@item
-RELICENSING
-
-``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
-World Wide Web server that publishes copyrightable works and also
-provides prominent facilities for anybody to edit those works. A
-public wiki that anybody can edit is an example of such a server. A
-``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
-site means any set of copyrightable works thus published on the MMC
-site.
-
-``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
-license published by Creative Commons Corporation, a not-for-profit
-corporation with a principal place of business in San Francisco,
-California, as well as future copyleft versions of that license
-published by that same organization.
-
-``Incorporate'' means to publish or republish a Document, in whole or
-in part, as part of another Document.
-
-An MMC is ``eligible for relicensing'' if it is licensed under this
-License, and if all works that were first published under this License
-somewhere other than this MMC, and subsequently incorporated in whole
-or in part into the MMC, (1) had no cover texts or invariant sections,
-and (2) were thus incorporated prior to November 1, 2008.
-
-The operator of an MMC Site may republish an MMC contained in the site
-under CC-BY-SA on the same site at any time before August 1, 2009,
-provided the MMC is eligible for relicensing.
-
-@end enumerate
-
-@page
-@heading ADDENDUM: How to use this License for your documents
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-@smallexample
-@group
- Copyright (C) @var{year} @var{your name}.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.3
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
- Texts. A copy of the license is included in the section entitled ``GNU
- Free Documentation License''.
-@end group
-@end smallexample
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the ``with@dots{}Texts.''@: line with this:
-
-@smallexample
-@group
- with the Invariant Sections being @var{list their titles}, with
- the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
- being @var{list}.
-@end group
-@end smallexample
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-@c Local Variables:
-@c ispell-local-pdict: "ispell-dict"
-@c End:
diff --git a/doc/info/solar-python.texinfo b/doc/info/solar-python.texinfo
deleted file mode 100644
index e33d6e0..0000000
--- a/doc/info/solar-python.texinfo
+++ /dev/null
@@ -1,511 +0,0 @@
-\input texinfo @c -*-texinfo-*-
-
-@c %**start of header
-@setfilename solar-python.info
-@settitle solar-python
-@afourpaper
-@documentencoding UTF-8
-@documentlanguage en
-@finalout
-@c %**end of header
-
-
-@dircategory Astronomy
-@direntry
-* solar-python: (solar-python). Solar data calculation and prediction library for Python
-@end direntry
-
-
-@copying
-Copyright @copyright{} 2015 Mattias Andrée
-
-@quotation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.3 or
-any later version published by the Free Software Foundation; with no
-Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-Texts. A copy of the license is included in the section entitled
-``GNU Free Documentation License''.
-@end quotation
-@end copying
-
-@ifnottex
-@node Top
-@top solar-python -- Solar data calculation and prediction library for Python
-@insertcopying
-@end ifnottex
-
-@titlepage
-@title solar-python
-@subtitle Solar data calculation and prediction library for Python
-@author by Mattias Andrée (maandree)
-
-@page
-@vskip 0pt plus 1filll
-@insertcopying
-@page
-@end titlepage
-
-@contents
-
-
-
-@menu
-* Overview:: Brief overview of @command{solar-python}.
-* Constants:: List of constants.
-* Calendar functions:: List of calendar functions.
-* Observation functions:: List of solar data observation functions.
-* Prediction functions:: List of solar data prediction functions.
-* Miscellaneous functions:: List of miscellaneous functions.
-* GNU Free Documentation License:: Copying and sharing this manual.
-@end menu
-
-
-
-@node Overview
-@chapter Overview
-
-@command{solar-python} is Python 3 library that can
-be used to calculate information about the Sun's
-position and related data and predict at when time
-solar events occur.
-
-Import the module @code{solar_python} to use the
-library.
-
-Documentation is available by the command @code{help}
-in python.
-
-
-
-@node Constants
-@chapter Constants
-
-Importing @code{solar_python} makes the following
-constants available:
-
-@table @code
-@item SOLAR_APPARENT_RADIUS = 32.0 / 60.0
-Approximate apparent size of the Sun in degrees.
-
-@item SOLAR_ELEVATION_PRESUNSET_POSTSUNRISE = 32.0 / 60.0
-The Sun's elevation at beginning of sunset
-and end of sunrise, measured in degrees.
-
-@item SOLAR_ELEVATION_SUNSET_SUNRISE = -32.0 / 60.0
-The Sun's elevation at (end of) sunset and
-(beginning of) sunrise, measured in degrees.
-
-@item SOLAR_ELEVATION_CIVIL_DUSK_DAWN = -6.0
-The Sun's elevation at civil dusk and civil dawn,
-measured in degrees
-
-@item SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN = -12.0
-The Sun's elevation at nautical dusk and nautical
-dawn, measured in degrees
-
-@item SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN = -18.0
-The Sun's elevation at astronomical dusk and
-astronomical dawn, measured in degrees
-
-@item SOLAR_ELEVATION_AMATEUR_ASTRONOMICAL_DUSK_DAWN = -15.0
-The Sun's elevation at amateur astronomical dusk and
-amateur astronomical dawn, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_TWILIGHT = (-18.0, 0.0)
-The Sun's lowest and highest elevation during all
-periods of twilight, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_CIVIL_TWILIGHT = (-6.0, -32.0 / 60.0)
-The Sun's lowest and highest elevation during
-civil twilight, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_NAUTICAL_TWILIGHT = (-12.0, -32.0 / 60.0)
-The Sun's lowest and highest elevation during
-nautical twilight, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_ASTRONOMICAL_TWILIGHT = (-18.0, -32.0 / 60.0)
-The Sun's lowest and highest elevation during
-astronomical twilight, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_AMATEUR_ASTRONOMICAL_TWILIGHT = (-15.0, -32.0 / 60.0)
-The Sun's lowest and highest elevation during
-amateur astronomical twilight, measured in degrees
-
-@item SOLAR_ELEVATION_RANGE_GOLDEN_HOUR = (-4.0, 6.0)
-The Sun's lowest and highest elevation during
-the golden hour (magic hour), measured in degrees.
-These elevations are approximate.
-
-@item SOLAR_ELEVATION_RANGE_BLUE_HOUR = (-6.0, -4.0)
-The Sun's lowest and highest elevation during
-the blue hour, measured in degrees. These
-elevations are approximate.
-@end table
-
-
-
-@node Calendar functions
-@chapter Calendar functions
-
-Importing @code{solar_python} makes the following
-calendar conversion functions available. All
-parameters are of the type @code{float}, and
-all functions return @code{float} except where
-noted otherwise.
-
-@table @code
-@item julian_day_to_epoch(t)
-Converts a Julian Day timestamp, @code{t}, to a POSIX time timestamp.
-
-@item epoch_to_julian_day(t)
-Converts a POSIX time timestamp, @code{t}, to a Julian Day timestamp
-
-@item julian_day_to_julian_centuries(t)
-Converts a Julian Day timestamp, @code{t}, to a Julian Centuries timestamp.
-
-@item julian_centuries_to_julian_day(t)
-Converts a Julian Centuries timestamp, @code{t}, to a Julian Day timestamp.
-
-@item epoch_to_julian_centuries(t)
-Converts a POSIX time timestamp, @code{t}, to a Julian Centuries timestamp.
-
-@item julian_centuries_to_epoch(t)
-Converts a Julian Centuries timestamp, @code{t}, to a POSIX time timestamp.
-@end table
-
-@code{solar_python} also makes the following
-functions available. All parameters are of the
-type @code{float}, and all functions return
-@code{float}.
-
-@table @code
-@item epoch()
-Get current POSIX time.
-
-@item julian_day()
-Get current Julian Day time.
-
-@item julian_centuries()
-Get current Julian Centuries time (100 Julian days since J2000.)
-@end table
-
-
-
-@node Observation functions
-@chapter Observation functions
-
-Importing @code{solar_python} makes the following
-solar data observation functions available. All
-parameters are of the type @code{float}, and
-all functions return @code{float}. All parameters
-named @code{t} or @code{noon} is the time in
-Julian Centuries. These are low-level functions.
-
-@table @code
-@item sun_geometric_mean_longitude(t)
-Calculates the Sun's geometric mean longitude.
-
-@item sun_geometric_mean_anomaly(t)
-Calculates the Sun's geometric mean anomaly, in radians.
-
-@item earth_orbit_eccentricity(t)
-Calculates the Earth's orbit eccentricity.
-
-@item sun_equation_of_centre(t)
-Calculates the Sun's equation of the centre --- the
-difference between the true anomaly and the mean
-anomaly --- in radians.
-
-@item sun_real_longitude(t)
-Calculates the Sun's real longitudinal position, in radians.
-
-@item sun_apparent_longitude(t)
-Calculates the Sun's apparent longitudinal position, in radians.
-
-@item mean_ecliptic_obliquity(t)
-Calculates the uncorrected mean ecliptic obliquity of the Sun's
-apparent motion without variation correction, in radians.
-
-@item corrected_mean_ecliptic_obliquity(t)
-Calculates the mean ecliptic obliquity of the Sun's apparent
-motion with variation correction, in radians.
-
-@item solar_declination(t)
-Calculates the Sun's declination, in radians.
-
-@item equation_of_time(t)
-Calculates the equation of time --- the discrepancy
-between apparent and mean solar time --- in degrees.
-
-@item hour_angle_from_elevation(latitude, declination, elevation)
-Calculates the solar hour angle, in radians, from the Sun's
-elevation, in radians. The Sun's elevation is gived by the
-parameter @code{elevation}. This functions requires two
-additional parameters:
-@table @code
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@item declination
-The declination, in radians.
-@end table
-
-@item elevation_from_hour_angle(latitude, declination, hour_angle)
-Calculates the Sun's elevation, in radians, from the solar
-hour angle, in radians. The solar hour angle is gived by the
-parameter @code{hour_angle}. This functions requires two
-additional parameters:
-@table @code
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@item declination
-The declination, in radians.
-@end table
-
-@item time_of_solar_noon(t, longitude)
-Calculates the time, in Julian Centuries, of the solar
-noon the closest to the time @code{t}. This functions
-requires one additional parameter:
-@table @code
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@end table
-
-@item time_of_solar_elevation(t, noon, latitude, longitude, elevation)
-Calculates the time, in Julian Centuries, the Sun has
-a specified apparent elevation, expressed in radians
-via the parameter @code{elevation}, at a geographical
-position, expressed in degrees by the parameters:
-@table @code
-@item latitude
-The latitude in degrees northwards from the equator,
-negative for southwards.
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@end table
-@noindent
-The function require two additional parameter:
-@table @code
-@item t
-A time, in Julian Centuries, close to the sought time.
-@item noon
-The time, in Julian Centuries, of the closest solar noon.
-@end table
-
-@item solar_elevation_from_time(t, latitude, longitude):
-Calculates the Sun's elevation, in radians, as apparent
-from a geographical position, expressed in degrees by the
-parameters:
-@table @code
-@item latitude
-The latitude in degrees northwards from the equator,
-negative for southwards.
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@end table
-@end table
-
-The library also provides the high-level functions:
-@table @code
-@item solar_elevation(latitude, longitude, t = None)
-Calculates the Sun's elevation, in degreesm as apparent
-from a geographical position, expressed in degrees by the parameters:
-@table @code
-@item latitude
-The latitude in degrees northwards from the equator,
-negative for southwards.
-@item longitude
-The longitude in degrees eastwards from Greenwich,
-negative for westwards.
-@end table
-@noindent
-The function also requires to the in Julian Centuries,
-provided via the parameter @code{t}. If @code{t} is
-@code{None}, the current time is used.
-
-@item have_sunrise_and_sunset(latitude, t = None)
-Determine whether solar declination currently is
-so that there can be sunrises and sunsets. If not,
-you either have 24-hour daytime or 24-hour nighttime.
-The function requires to the in Julian Centuries,
-provided via the parameter @code{t}, and the latitude,
-provided via the parameter @code{latitude}, in degrees
-northwards from the equator, negative for southwards.
-If @code{t} is @code{None}, the current time is used.
-
-This function returns a boolean.
-
-@item is_summer(latitude, t = None)
-Determine whether it is summer on the hemisphere
-ont which you are located.
-The function requires to the in Julian Centuries,
-provided via the parameter @code{t}, and the latitude,
-provided via the parameter @code{latitude}, in degrees
-northwards from the equator, negative for southwards.
-If @code{t} is @code{None}, the current time is used.
-
-This function returns a boolean.
-
-@item is_winter(latitude, t = None)
-Determine whether it is winter on the hemisphere
-ont which you are located.
-The function requires to the in Julian Centuries,
-provided via the parameter @code{t}, and the latitude,
-provided via the parameter @code{latitude}, in degrees
-northwards from the equator, negative for southwards.
-If @code{t} is @code{None}, the current time is used.
-
-This function returns a boolean.
-@end table
-
-
-
-@node Prediction functions
-@chapter Prediction functions
-
-Importing @code{solar_python} makes the following
-solar data prediction functions available. All
-parameters are of the type @code{float}, and
-all functions return @code{float}. All parameters
-named @code{t} is the time in Julian Centuries,
-and the current time if set to @code{None}. Some
-functions require the geographical position of
-the observer. This latitude is provided via the
-parameter @code{latitude} in degrees northwards
-from the equator, negative for southwards.
-This longitude is provided via the parameter
-@code{longitude} in degrees eastwards from
-Greenwich, negative for westwards.
-
-@table @code
-@item solar_prediction(delta, requested, fun, epsilon = 0.000001, span = 0.01, t = None)
-Predict the time point of the next or previous
-time an arbitrary condition is meet. This function
-returns the calculated time in Julian Centuries,
-or @code{None} if the condition is not meet within
-the specified timespan, specified by the parameter
-@code{span} in Julian Centuries (@code{0.01} for
-one year).
-
-The function shall find the input --- one parameter
-in Julian Centuries --- for which the function-parameter
-@code{fun} returns the value of @code{requested} within
-an error tolerance of @code{epsilon}.
-
-The function uses the iteration step size @code{delta}.
-If this value is negative, a past event will be determined,
-and if it is positive, a future event will be predicted.
-
-@item future_past_equinox(delta, t = None)
-Predict the time point, in Julian Centuries, of the
-next or previous equinox.
-
-The function uses the iteration step size @code{delta}.
-If this value is negative, a past event will be determined,
-and if it is positive, a future event will be predicted.
-
-@item future_equinox(t = None)
-Predict the time point, in Julian Centuries, of the
-next equinox.
-
-@item past_equinox(t = None)
-Predict the time point, in Julian Centuries, of the
-previous equinox.
-
-@item future_past_solstice(delta, t = None)
-Predict the time point, in Julian Centuries, of the
-next or previous solstice.
-
-The function uses the iteration step size @code{delta}.
-If this value is negative, a past event will be determined,
-and if it is positive, a future event will be predicted.
-
-@item future_solstice(t = None)
-Predict the time point, in Julian Centuries, of the
-next solstice.
-
-@item past_solstice(t = None)
-Predict the time point, in Julian Centuries, of the
-previous solstice.
-
-@item future_past_elevation(delta, latitude, longitude, elevation, t = None)
-Predict the time point, in Julian Centuries, of the next
-or previous time the Sun reaches or reached a specific
-elevation, specified in degrees via the parameter
-@code{elevation}. @code{None} is returned if not found
-withing a year.
-
-The function uses the iteration step size @code{delta}.
-If this value is negative, a past event will be determined,
-and if it is positive, a future event will be predicted.
-
-@item future_elevation(latitude, longitude, elevation, t = None)
-Predict the time point, in Julian Centuries, of the next
-time the Sun reaches a specific elevation, specified in
-degrees via the parameter @code{elevation}. @code{None}
-is returned if not found withing a year.
-
-@item past_elevation(latitude, longitude, elevation, t = None)
-Predict the time point, in Julian Centuries, of the previous
-time the Sun reached a specific elevation, specified in
-degrees via the parameter @code{elevation}. @code{None}
-is returned if not found withing a year.
-
-@item future_past_elevation_derivative(delta, latitude, longitude, derivative, t = None)
-Predict the time point, in Julian Centuries, of the next or
-previous time the Sun reaches or reached a specific elevation
-derivative. @code{None} is returned if not found withing a
-year. The sought derivative is specified via the parameter
-@code{derivative}, expressed in degrees per Julian Century.
-
-The function uses the iteration step size @code{delta}. If
-this value is negative, a past event will be determined, and
-if it is positive, a future event will be predicted.
-
-@item future_elevation_derivative(latitude, longitude, derivative, t = None)
-Predict the time point, in Julian Centuries, of the next time
-the Sun reaches a specific elevation derivative. @code{None}
-is returned if not found withing a year. The sought derivative
-is specified via the parameter @code{derivative}, expressed in
-degrees per Julian Century.
-
-@item past_elevation_derivative(latitude, longitude, derivative, t = None)
-Predict the time point, in Julian Centuries, of the previous
-time the Sun reached a specific elevation derivative.
-@code{None} is returned if not found withing a year. The
-sought derivative is specified via the parameter
-@code{derivative}, expressed in degrees per Julian Century.
-
-@item sunrise_equation(latitude, longitude, t = None)
-This algorithm is imprecise, gives an incorrent sunrise.
-Its behaviour is not fully known.
-@end table
-
-
-
-@node Miscellaneous functions
-@chapter Miscellaneous functions
-
-Importing @code{solar_python} makes the following
-functions available:
-@table @code
-@item radians(deg)
-Convert an angle from degrees to radians.
-
-@item degrees(rad)
-Convert an angle from radians to degrees.
-@end table
-
-
-
-@node GNU Free Documentation License
-@appendix GNU Free Documentation License
-@include fdl.texinfo
-
-@bye
-