From ec7baa81e8fd4bec924d6adf3ee880af621a10ba Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Fri, 19 Feb 2021 22:10:26 +0100 Subject: Imrpove makefile and flatten the hier a bit MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- .gitignore | 18 +- Makefile | 196 +--------- doc/info/fdl.texinfo | 505 ------------------------- doc/info/solar-python.texinfo | 511 ------------------------- info/fdl.texinfo | 505 +++++++++++++++++++++++++ info/solar-python.texinfo | 511 +++++++++++++++++++++++++ solar_python.py | 846 ++++++++++++++++++++++++++++++++++++++++++ src/solar_python.py | 846 ------------------------------------------ 8 files changed, 1881 insertions(+), 2057 deletions(-) delete mode 100644 doc/info/fdl.texinfo delete mode 100644 doc/info/solar-python.texinfo create mode 100644 info/fdl.texinfo create mode 100644 info/solar-python.texinfo create mode 100644 solar_python.py delete mode 100644 src/solar_python.py diff --git a/.gitignore b/.gitignore index a5d1b5a..4f40d2f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,23 +1,9 @@ -_/ -/bin/ -/obj/ -\#*\# -.* -!.git* +*\#* *~ -*.swp -*.swo -*.bak +__pycache__/ *.pyc *.pyo -__pycache__/ *.info *.pdf *.dvi *.ps -*.tar -*.gz -*.bz2 -*.xz -!solar-python.install - diff --git a/Makefile b/Makefile index 010c1fe..072ef25 100644 --- a/Makefile +++ b/Makefile @@ -1,194 +1,32 @@ -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. This file is offered as-is, -# without any warranty. +.POSIX: - -# The package path prefix, if you want to install to another root, set DESTDIR to that root PREFIX = /usr -# The library path excluding prefix -LIB = /lib -# The resource path excluding prefix -DATA = /share -# The library path including prefix -LIBDIR = $(PREFIX)$(LIB) -# The resource path including prefix -DATADIR = $(PREFIX)$(DATA) -# The generic documentation path including prefix -DOCDIR = $(DATADIR)/doc -# The info manual documentation path including prefix -INFODIR = $(DATADIR)/info -# The license base path including prefix -LICENSEDIR = $(DATADIR)/licenses - -# The name of the package as it should be installed -PKGNAME = solar-python - -# The major version number of the current Python installation -PY_MAJOR = 3 -# The minor version number of the current Python installation -PY_MINOR = 5 -# The version number of the current Python installation without a dot -PY_VER = $(PY_MAJOR)$(PY_MINOR) -# The version number of the current Python installation with a dot -PY_VERSION = $(PY_MAJOR).$(PY_MINOR) - -# The modules this library is comprised of -SRC = solar_python - -# Filename extension for -OO optimised python files -ifeq ($(shell test $(PY_VER) -ge 35 ; echo $$?),0) -PY_OPT2_EXT = opt-2.pyc -else -PY_OPT2_EXT = pyo -endif - - - -.PHONY: default -default: base info - -.PHONY: all -all: base doc - -.PHONY: base -base: compiled optimised +PYTHON_MAJOR = $$(python --version 2>&1 | cut -d . -f 1 | cut -d ' ' -f 2) +PYTHON_MINOR = $$(python$(PYTHON_MAJOR) --version 2>&1 | cut -d . -f 2) -.PHONY: compiled -compiled: $(foreach M,$(SRC),src/__pycache__/$(M).cpython-$(PY_VER).pyc) +all: + @true -.PHONY: optimised -optimised: $(foreach M,$(SRC),src/__pycache__/$(M).cpython-$(PY_VER).$(PY_OPT2_EXT)) +info: solar-python.info - -src/__pycache__/%.cpython-$(PY_VER).pyc: src/%.py - python -m compileall $< - -src/__pycache__/solar_python.cpython-$(PY_VER).$(PY_OPT2_EXT): src/solar_python.py - python -OO -m compileall $< - - -.PHONY: doc -doc: info pdf dvi ps - -.PHONY: info -info: bin/solar-python.info -bin/%.info: doc/info/%.texinfo - @mkdir -p bin +solar-python.info: info/solar-python.texinfo info/fdl.texinfo $(MAKEINFO) $< - mv $*.info $@ - -.PHONY: pdf -pdf: bin/solar-python.pdf -bin/%.pdf: doc/info/%.texinfo - @! test -d obj/pdf || rm -rf obj/pdf - @mkdir -p bin obj/pdf - cd obj/pdf && texi2pdf ../../"$<" < /dev/null - mv obj/pdf/$*.pdf $@ - -.PHONY: dvi -dvi: bin/solar-python.dvi -bin/%.dvi: doc/info/%.texinfo - @! test -d obj/dvi || rm -rf obj/dvi - @mkdir -p bin obj/dvi - cd obj/dvi && $(TEXI2DVI) ../../"$<" < /dev/null - mv obj/dvi/$*.dvi $@ - -.PHONY: ps -ps: bin/solar-python.ps -bin/%.ps: doc/info/%.texinfo - @! test -d obj/ps || rm -rf obj/ps - @mkdir -p bin obj/ps - cd obj/ps && texi2pdf --ps ../../"$<" < /dev/null - mv obj/ps/$*.ps $@ - - -.PHONY: install -install: install-base install-info +install: + mkdir -p -- "$(DESTDIR)$(PREFIX)/lib/python$(PYTHON_MAJOR).$(PYTHON_MINOR)/site-packages" + cp -- solar_python.py "$(DESTDIR)$(PREFIX)/lib/python$(PYTHON_MAJOR).$(PYTHON_MINOR)/site-packages/" -.PHONY: install-all -install-all: install-base install-doc +install-info: solar-python.info + mkdir -p -- "$(DESTDIR)$(PREFIX)/share/info" + cp -- solar-python.info "$(DESTDIR)$(PREFIX)/share/info/" -.PHONY: install-base -install-base: install-lib install-copyright - - -.PHONY: install-lib -install-lib: install-source install-compiled install-optimised - -.PHONY: install-source -install-source: $(foreach M,$(SRC),src/$(M).py) - install -dm755 -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)" - install -m644 $^ -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)" - -.PHONY: install-compiled -install-compiled: $(foreach M,$(SRC),src/__pycache__/$(M).cpython-$(PY_VER).pyc) - install -dm755 -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__" - install -m644 $^ -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__" - -.PHONY: install-optimised -install-optimised: $(foreach M,$(SRC),src/__pycache__/$(M).cpython-$(PY_VER).$(PY_OPT2_EXT)) - install -dm755 -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__" - install -m644 $^ -- "$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__" - - -.PHONY: install-copyright -install-copyright: install-copying install-license - -.PHONY: install-copying -install-copying: COPYING - install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - install -m644 $^ -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -.PHONY: install-license -install-license: LICENSE - install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - install -m644 $^ -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - - -.PHONY: install-doc -install-doc: install-info install-pdf install-dvi install-ps - -.PHONY: install-info -install-info: bin/solar-python.info - install -dm755 -- "$(DESTDIR)$(INFODIR)" - install -m644 $< -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -.PHONY: install-pdf -install-pdf: bin/solar-python.pdf - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -.PHONY: install-dvi -install-dvi: bin/solar-python.dvi - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -.PHONY: install-ps -install-ps: bin/solar-python.ps - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 -- "$<" "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - - - -.PHONY: uninstall uninstall: - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING" - -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -rm -- $(foreach M,$(SRC),"$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__/$(M).cpython-$(PY_VER).$(PY_OPT2_EXT)") - -rm -- $(foreach M,$(SRC),"$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/__pycache__/$(M).cpython-$(PY_VER).pyc") - -rm -- $(foreach M,$(SRC),"$(DESTDIR)$(LIBDIR)/python$(PY_VERSION)/$(M).py") - -rm -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - - + -rm -f -- "$(DESTDIR)$(PREFIX)/lib/python$(PYTHON_MAJOR).$(PYTHON_MINOR)/site-packages/solar_python.py" + -rm -f -- "$(DESTDIR)$(PREFIX)/share/info/solar-python.info" .PHONY: clean clean: - -rm -r src/__pycache__ obj bin + -rm -rf -- *.pyc *.pyo __pycache__ *.info +.PHONY: all info install install-info uninstall clean 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 - diff --git a/info/fdl.texinfo b/info/fdl.texinfo new file mode 100644 index 0000000..cb71f05 --- /dev/null +++ b/info/fdl.texinfo @@ -0,0 +1,505 @@ +@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/info/solar-python.texinfo b/info/solar-python.texinfo new file mode 100644 index 0000000..e33d6e0 --- /dev/null +++ b/info/solar-python.texinfo @@ -0,0 +1,511 @@ +\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 + diff --git a/solar_python.py b/solar_python.py new file mode 100644 index 0000000..e336ab4 --- /dev/null +++ b/solar_python.py @@ -0,0 +1,846 @@ +# solar-python — Solar data calculation and prediction library for Python +# Copyright © 2014, 2015 Mattias Andrée (maandree@member.fsf.org) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + + +SOLAR_APPARENT_RADIUS = 32.0 / 60.0 +''' +:float Approximate apparent size of the Sun in degrees +''' + + +SOLAR_ELEVATION_PRESUNSET_POSTSUNRISE = 32.0 / 60.0 +''' +:float The Sun's elevation the beginning of sunset and + end of sunrise, measured in degrees +''' + +SOLAR_ELEVATION_SUNSET_SUNRISE = -32.0 / 60.0 +''' +:float The Sun's elevation the (end of) at sunset and + (beginning of) sunrise, measured in degrees +''' + +SOLAR_ELEVATION_CIVIL_DUSK_DAWN = -6.0 +''' +:float The Sun's elevation at civil dusk and civil + dawn, measured in degrees +''' + +SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN = -12.0 +''' +:float The Sun's elevation at nautical dusk and + nautical dawn, measured in degrees +''' + +SOLAR_ELEVATION_AMATEUR_ASTRONOMICAL_DUSK_DAWN = -15.0 +''' +:float The Sun's elevation at amateur astronomical dusk + and amateur astronomical dawn, measured in degrees +''' + +SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN = -18.0 +''' +:float The Sun's elevation at astronomical dusk + and astronomical dawn, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_TWILIGHT = (-18.0, 0.0) +''' +:(float, float) The Sun's lowest and highest elevation during + all periods of twilight, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_CIVIL_TWILIGHT = (-6.0, SOLAR_ELEVATION_SUNSET_SUNRISE) +''' +:(float, float) The Sun's lowest and highest elevation + during civil twilight, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_NAUTICAL_TWILIGHT = (-12.0, SOLAR_ELEVATION_SUNSET_SUNRISE) +''' +:(float, float) The Sun's lowest and highest elevation + during nautical twilight, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_ASTRONOMICAL_TWILIGHT = (-18.0, SOLAR_ELEVATION_SUNSET_SUNRISE) +''' +:(float, float) The Sun's lowest and highest elevation during + astronomical twilight, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_AMATEUR_ASTRONOMICAL_TWILIGHT = (-18.0, -15.0) +''' +:(float, float) The Sun's lowest and highest elevation during + amateur astronomical twilight, measured in degrees +''' + +SOLAR_ELEVATION_RANGE_GOLDEN_HOUR = (-4.0, 6.0) +''' +:(float, float) The Sun's lowest and highest elevation during + the golden "hour" (also known as magic hour), + measured in degrees. These elevations are + approximate. +''' + +SOLAR_ELEVATION_RANGE_BLUE_HOUR = (-6.0, -4.0) +''' +:(float, float) The Sun's lowest and highest elevation during + the blue "hour", measured in degrees. These + elevations are approximate. +''' + + + +# The following functions are used to calculate the result for `sun` +# (most of them) but could be used for anything else. There name is +# should tell you enough, `t` (and `noon`) is in Julian Centuries +# except for in the convertion methods. + + +def julian_day_to_epoch(t): + ''' + Converts a Julian Day timestamp to a POSIX time timestamp + + @param t:float The time in Julian Days + @return :float The time in POSIX time + ''' + return (t - 2440587.5) * 86400.0 + + +def epoch_to_julian_day(t): + ''' + Converts a POSIX time timestamp to a Julian Day timestamp + + @param t:float The time in POSIX time + @return :float The time in Julian Days + ''' + return t / 86400.0 + 2440587.5 + + +def julian_day_to_julian_centuries(t): + ''' + Converts a Julian Day timestamp to a Julian Centuries timestamp + + @param t:float The time in Julian Days + @return :float The time in Julian Centuries + ''' + return (t - 2451545.0) / 36525.0 + + +def julian_centuries_to_julian_day(t): + ''' + Converts a Julian Centuries timestamp to a Julian Day timestamp + + @param t:float The time in Julian Centuries + @return :float The time in Julian Days + ''' + return t * 36525.0 + 2451545.0 + + +def epoch_to_julian_centuries(t): + ''' + Converts a POSIX time timestamp to a Julian Centuries timestamp + + @param t:float The time in POSIX time + @return :float The time in Julian Centuries + ''' + return julian_day_to_julian_centuries(epoch_to_julian_day(t)) + + +def julian_centuries_to_epoch(t): + ''' + Converts a Julian Centuries timestamp to a POSIX time timestamp + + @param t:float The time in Julian Centuries + @return :float The time in POSIX time + ''' + return julian_day_to_epoch(julian_centuries_to_julian_day(t)) + + +def epoch(): + ''' + Get current POSIX time + + @return :float The current POSIX time + ''' + import time + return time.time() + + +def julian_day(): + ''' + Get current Julian Day time + + @return :float The current Julian Day time + ''' + return epoch_to_julian_day(epoch()) + + +def julian_centuries(): + ''' + Get current Julian Centuries time (100 Julian days since J2000) + + @return :float The current Julian Centuries time + ''' + return epoch_to_julian_centuries(epoch()) + + +def radians(deg): + ''' + Convert an angle from degrees to radians + + @param deg:float The angle in degrees + @return :float The angle in radians + ''' + import math + return deg * math.pi / 180 + + +def degrees(rad): + ''' + Convert an angle from radians to degrees + + @param rad:float The angle in radians + @return :float The angle in degrees + ''' + import math + return rad * 180 / math.pi + + +def sun_geometric_mean_longitude(t): + ''' + Calculates the Sun's geometric mean longitude + + @param t:float The time in Julian Centuries + @return :float The Sun's geometric mean longitude in radians + ''' + return radians((0.0003032 * t ** 2 + 36000.76983 * t + 280.46646) % 360) + # CANNIBALISERS: + # The result of this function should always be positive, this + # means that after division modulo 360 but before `radians`, + # you will need to add 360 if the value is negative. This can + # only happen if `t` is negative, which can only happen for date + # times before 2000-(01)Jan-01 12:00:00 UTC par division modulo + # implementations with the signess of at least the left operand. + # More precively, it happens between circa 1970-(01)Jan-11 + # 16:09:02 UTC and circa 374702470660351740 seconds before + # January 1, 1970 00:00 UTC, which is so far back in time + # it cannot be reliable pinned down to the right year, but it + # is without a shadow of a doubt looooong before the Earth + # was formed, is right up there with the age of the Milky Way + # and the universe itself. + + +def sun_geometric_mean_anomaly(t): + ''' + Calculates the Sun's geometric mean anomaly + + @param t:float The time in Julian Centuries + @return :float The Sun's geometric mean anomaly in radians + ''' + return radians(-0.0001537 * t ** 2 + 35999.05029 * t + 357.52911) + + +def earth_orbit_eccentricity(t): + ''' + Calculates the Earth's orbit eccentricity + + @param t:float The time in Julian Centuries + @return :float The Earth's orbit eccentricity + ''' + return -0.0000001267 * t ** 2 - 0.000042037 * t + 0.016708634 + + +def sun_equation_of_centre(t): + ''' + Calculates the Sun's equation of the centre, the difference between + the true anomaly and the mean anomaly + + @param t:float The time in Julian Centuries + @return :float The Sun's equation of the centre, in radians + ''' + import math + a = sun_geometric_mean_anomaly(t) + rc = math.sin(1 * a) * (-0.000014 * t ** 2 - 0.004817 * t + 1.914602) + rc += math.sin(2 * a) * (-0.000101 * t + 0.019993) + rc += math.sin(3 * a) * 0.000289 + return radians(rc) + + +def sun_real_longitude(t): + ''' + Calculates the Sun's real longitudinal position + + @param t:float The time in Julian Centuries + @return :float The longitude, in radians + ''' + rc = sun_geometric_mean_longitude(t) + return rc + sun_equation_of_centre(t) + + +def sun_apparent_longitude(t): + ''' + Calculates the Sun's apparent longitudinal position + + @param t:float The time in Julian Centuries + @return :float The longitude, in radians + ''' + import math + rc = degrees(sun_real_longitude(t)) - 0.00569 + rc -= 0.00478 * math.sin(radians(-1934.136 * t + 125.04)) + return radians(rc) + + +def mean_ecliptic_obliquity(t): + ''' + Calculates the mean ecliptic obliquity of the Sun's + apparent motion without variation correction + + @param t:float The time in Julian Centuries + @return :float The uncorrected mean obliquity, in radians + ''' + rc = 0.001813 * t ** 3 - 0.00059 * t ** 2 - 46.815 * t + 21.448 + rc = 26 + rc / 60 + rc = 23 + rc / 60 + return radians(rc) + + +def corrected_mean_ecliptic_obliquity(t): + ''' + Calculates the mean ecliptic obliquity of the Sun's + apparent motion with variation correction + + @param t:float The time in Julian Centuries + @return :float The mean obliquity, in radians + ''' + import math + rc = -1934.136 * t + 125.04 + rc = 0.00256 * math.cos(radians(rc)) + rc += degrees(mean_ecliptic_obliquity(t)) + return radians(rc) + + +def solar_declination(t): + ''' + Calculates the Sun's declination + + @param t:float The time in Julian Centuries + @return :float The Sun's declination, in radians + ''' + import math + rc = math.sin(corrected_mean_ecliptic_obliquity(t)) + rc *= math.sin(sun_apparent_longitude(t)) + return math.asin(rc) + + +def equation_of_time(t): + ''' + Calculates the equation of time, the discrepancy + between apparent and mean solar time + + @param t:float The time in Julian Centuries + @return :float The equation of time, in degrees + ''' + import math + l = sun_geometric_mean_longitude(t) + e = earth_orbit_eccentricity(t) + m = sun_geometric_mean_anomaly(t) + y = corrected_mean_ecliptic_obliquity(t) + y = math.tan(y / 2) ** 2 + rc = y * math.sin(2 * l) + rc += (4 * y * math.cos(2 * l) - 2) * e * math.sin(m) + rc -= 0.5 * y ** 2 * math.sin(4 * l) + rc -= 1.25 * e ** 2 * math.sin(2 * m) + return 4 * degrees(rc) + + +def hour_angle_from_elevation(latitude, declination, elevation): + ''' + Calculates the solar hour angle from the Sun's elevation + + @param longitude:float The longitude in degrees eastwards + from Greenwich, negative for westwards + @param declination:float The declination, in radians + @param elevation:float The Sun's elevation, in radians + @return :float The solar hour angle, in radians + ''' + import math + if elevation == 0: + return 0 + rc = math.cos(abs(elevation)) + rc -= math.sin(radians(latitude)) * math.sin(declination) + rc /= math.cos(radians(latitude)) * math.cos(declination) + rc = math.acos(rc) + return -rc if (rc < 0) == (elevation < 0) else rc + + +def elevation_from_hour_angle(latitude, declination, hour_angle): + ''' + Calculates the Sun's elevation from the solar hour angle + + @param longitude:float The longitude in degrees eastwards + from Greenwich, negative for westwards + @param declination:float The declination, in radians + @param hour_angle:float The solar hour angle, in radians + @return :float The Sun's elevation, in radians + ''' + import math + rc = math.cos(radians(latitude)) + rc *= math.cos(hour_angle) * math.cos(declination) + rc += math.sin(radians(latitude)) * math.sin(declination) + return math.asin(rc) + + +def time_of_solar_noon(t, longitude): + ''' + Calculates the time of the closest solar noon + + @param t:float A time close to the sought time, + in Julian Centuries + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @return :float The time, in Julian Centuries, + of the closest solar noon + ''' + t, rc = julian_centuries_to_julian_day(t), longitude + for (k, m) in ((-360, 0), (1440, -0.5)): + rc = julian_day_to_julian_centuries(t + m + rc / k) + rc = 720 - 4 * longitude - equation_of_time(rc) + return rc + + +def time_of_solar_elevation(t, noon, latitude, longitude, elevation): + ''' + Calculates the time the Sun has a specified apparent + elevation at a geographical position + + @param t:float A time close to the sought time, + in Julian Centuries + @param noon:float The time of the closest solar noon + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param elevation:float The solar elevation, in radians + @return :float The time, in Julian Centuries, + of the specified elevation + ''' + rc = noon + rc, et = solar_declination(rc), equation_of_time(rc) + rc = hour_angle_from_elevation(latitude, rc, elevation) + rc = 720 - 4 * (longitude + degrees(rc)) - et + + rc = julian_day_to_julian_centuries(julian_centuries_to_julian_day(t) + rc / 1440) + rc, et = solar_declination(rc), equation_of_time(rc) + rc = hour_angle_from_elevation(latitude, rc, elevation) + rc = 720 - 4 * (longitude + degrees(rc)) - et + return rc + + +def solar_elevation_from_time(t, latitude, longitude): + ''' + Calculates the Sun's elevation as apparent + from a geographical position + + @param t:float The time in Julian Centuries + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @return :float The Sun's apparent elevation at the specified + time as seen from the specified position, + measured in radians + ''' + rc = julian_centuries_to_julian_day(t) + rc = (rc - float(int(rc + 0.5)) - 0.5) * 1440 + rc = 720 - rc - equation_of_time(t) + rc = radians(rc / 4 - longitude) + return elevation_from_hour_angle(latitude, solar_declination(t), rc) + + +def solar_elevation(latitude, longitude, t = None): + ''' + Calculates the Sun's elevation as apparent + from a geographical position + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float The Sun's apparent elevation at the specified + time as seen from the specified position, + measured in degrees + ''' + rc = julian_centuries() if t is None else t + rc = solar_elevation_from_time(rc, latitude, longitude) + return degrees(rc) + + + +def 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. + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param t:float? The time in Julian Centuries, `None` + for the current time + @return Whether there can be sunrises and + sunsets where you are located + ''' + t = julian_centuries() if t is None else t + d = degrees(solar_declination(t)) + ## Convert everything to the Northern hemisphere + latitude = abs(latitude) + if d >= 0: + ## Northern summer + return -90 + d < latitude < 90 - d + else: + ## Northern winter + return -90 - d < latitude < 90 + d + + +def is_summer(latitude, t = None): + ''' + Determine whether it is summer + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param t:float? The time in Julian Centuries, `None` + for the current time + @return Whether it is summer on the hemisphere + you are located on + ''' + t = julian_centuries() if t is None else t + d = solar_declination(t) + return (d > 0) == (latitude > 0) + + +def is_winter(latitude, t = None): + ''' + Determine whether it is winter + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param t:float? The time in Julian Centuries, `None` + for the current time + @return Whether it is winter on the hemisphere + you are located on + ''' + t = julian_centuries() if t is None else t + d = solar_declination(t) + return not ((d > 0) == (latitude > 0)) + + + +def 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 + + @param delta:float Iteration step size, negative for past + event, positive for future event + @param requested:float The value returned by `fun` for which to + calculate the time point of occurrence + @param fun:(t:float)→float Function that calculate the data of interest + @param epsilon:float The tolerance for the result + @param span:float The number of Julian Centuries (0,01 for + one year) to restrict the search to + @param t:float? The time in Julian Centuries, `None` for + the current time + @return :float? The calculated time point, `None` if none + were found within the specified time span + ''' + fun_ = lambda t : fun(t) - requested + t = julian_centuries() if t is None else t + t1 = t2 = t + v1 = v0 = fun_(t) + + # Predicate time point to within a small time span + while True: + if abs(t2 - t) > span: + return None + t2 += delta + v2 = fun_(t2) + if (v1 <= 0 <= v2) or ((0 >= v1 >= v2) and (0 <= v0)): + break + if (v1 >= 0 >= v2) or ((0 <= v1 <= v2) and (0 >= v0)): + break + t1 = t2 + v2 = v1 + + # Binary search the small time span for the exact time point + for _itr in range(1000): + tm = (t1 + t2) / 2 + v1 = fun_(t1) + v2 = fun_(t2) + vm = fun_(tm) + if abs(v1 - v2) < epsilon: + return tm + if v1 < v2: + if 0 < vm: + t2 = tm + else: + t1 = tm + elif v1 > v2: + if 0 > vm: + t2 = tm + else: + t1 = tm + return tm + + + +def future_past_equinox(delta, t = None): + ''' + Predict the time point of the next or previous equinox + + @param delta:float Iteration step size, negative for + past event, positive for future event + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float The calculated time point + ''' + return solar_prediction(delta, 0, solar_declination, t = t) + + +def future_equinox(t = None): + ''' + Predict the time point of the next equinox + + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float The calculated time point + ''' + return future_past_equinox(0.01 / 2000, t) + + +def past_equinox(t = None): + ''' + Predict the time point of the previous equinox + + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float The calculated time point + ''' + return future_past_equinox(0.01 / -2000, t) + + + +def future_past_solstice(delta, t = None): + ''' + Predict the time point of the next or previous solstice + + @param delta:float Iteration step size, negative for + past event, positive for future event + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float The calculated time point + ''' + e = 0.00001 + fun = solar_declination + dfun = lambda t : (fun(t + e) - fun(t - e)) / (2 * e) + return solar_prediction(delta, 0, dfun, t = t) + + +def future_solstice(t = None): + ''' + Predict the time point of the next solstice + + @param t:float? The time in Julian Centuries, + `None` for the current time + @return :float The calculated time point + ''' + return future_past_solstice(0.01 / 2000, t) + + +def past_solstice(t = None): + ''' + Predict the time point of the previous solstice + + @param t:float? The time in Julian Centuries, + `None` for the current time + @return :float The calculated time point + ''' + return future_past_solstice(0.01 / -2000, t) + + + +def future_past_elevation(delta, latitude, longitude, elevation, t = None): + ''' + Predict the time point of the next or previous time + the Sun reaches or reached a specific elevation + + @param delta:float Iteration step size, negative for past + event, positive for future event + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param elevation:float The elevation of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` if + none were found within a year + ''' + fun = lambda t : solar_elevation(latitude, longitude, t) + return solar_prediction(delta, elevation, fun, t = t) + + +def future_elevation(latitude, longitude, elevation, t = None): + ''' + Predict the time point of the next time the Sun + reaches a specific elevation + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param elevation:float The elevation of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` if + none were found within a year + ''' + return future_past_elevation(0.01 / 2000, latitude, longitude, elevation, t) + + +def past_elevation(latitude, longitude, elevation, t = None): + ''' + Predict the time point of the previous time the Sun + reached a specific elevation + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param elevation:float The elevation of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` if + none were found within a year + ''' + return future_past_elevation(0.01 / -2000, latitude, longitude, elevation, t) + + + +def future_past_elevation_derivative(delta, latitude, longitude, derivative, t = None): + ''' + Predict the time point of the next or previous time the + Sun reaches or reached a specific elevation derivative + + @param delta:float Iteration step size, negative for past + event, positive for future event + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param derivative:float The elevation derivative value of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` if + none were found within a year + ''' + e = 0.00001 + fun = lambda t : solar_elevation(latitude, longitude, t) + dfun = lambda t : (fun(t + e) - fun(t - e)) / (2 * e) + return solar_prediction(delta, derivative, dfun, t = t) + + +def future_elevation_derivative(latitude, longitude, derivative, t = None): + ''' + Predict the time point of the next time the + Sun reaches a specific elevation derivative + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param derivative:float The elevation derivative value of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` if + none were found within a year + ''' + return future_past_elevation_derivative(0.01 / 2000, latitude, longitude, derivative, t) + + +def past_elevation_derivative(latitude, longitude, derivative, t = None): + ''' + Predict the time point of the previous time + the Sun reached a specific elevation derivative + + @param latitude:float The latitude in degrees northwards from + the equator, negative for southwards + @param longitude:float The longitude in degrees eastwards from + Greenwich, negative for westwards + @param derivative:float The elevation derivative value of interest + @param t:float? The time in Julian Centuries, `None` + for the current time + @return :float? The calculated time point, `None` + if none were found within a year + ''' + return future_past_elevation_derivative(0.01 / -2000, latitude, longitude, derivative, t) + + + +# TODO: This algorithm is imprecise, gives an incorrent sunrise and I do not fully know its behaviour +def sunrise_equation(latitude, longitude, t = None): + import math + # Calculate Julian Cycle + j_cent = julian_centuries() if t is None else t + j_date = julian_centuries_to_julian_day(j_cent) + j_cycle = int(j_date - 2451545.0009 - longitude / 360 + 0.5) + + # Calculate approximate solar noon and solar man anomaly + approx_solar_noon = 451545.0009 + longitude / 360 + j_cycle + solar_mean_anomaly = int(357.5291 + 0.98560028 * (j_cycle - 2451545)) % 360 + + # Calculate solar equation of centre + equation_of_centre = 1.9148 * math.sin(1 * solar_mean_anomaly) + equation_of_centre += 0.0200 * math.sin(2 * solar_mean_anomaly) + equation_of_centre += 0.0003 * math.sin(3 * solar_mean_anomaly) + + # Calculate solar ecliptic longitude + ecliptic_longitude = (solar_mean_anomaly + 102.9372 + equation_of_centre + 180) % 360 + + # Calculate solar transit + solar_transit = approx_solar_noon + 0.0053 * math.sin(solar_mean_anomaly) + solar_transit -= 0.0069 * math.sin(2 * ecliptic_longitude) + + # Calculate solar declination + declination = math.asin(math.sin(ecliptic_longitude) * math.sin(radians(23.45))) + + # Calculate solar hour angle + hour_angle = math.sin(radians(-0.83)) + hour_angle -= math.sin(latitude) * math.sin(declination) + hour_angle /= math.cos(latitude) * math.cos(declination) + hour_angle = degrees(math.acos(hour_angle)) + + # Calculate time of sunset and sunrise + sunset = 2451545.0009 + (hour_angle + longitude) / 360 + sunset += j_cycle + solar_transit - approx_solar_noon + sunrise = 2 * solar_transit - sunset + + # Convert to Julian Centuries + return (julian_day_to_julian_centuries(sunset), + julian_day_to_julian_centuries(sunrise)) + diff --git a/src/solar_python.py b/src/solar_python.py deleted file mode 100644 index e336ab4..0000000 --- a/src/solar_python.py +++ /dev/null @@ -1,846 +0,0 @@ -# solar-python — Solar data calculation and prediction library for Python -# Copyright © 2014, 2015 Mattias Andrée (maandree@member.fsf.org) -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU Affero General Public License for more details. -# -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see . - - - -SOLAR_APPARENT_RADIUS = 32.0 / 60.0 -''' -:float Approximate apparent size of the Sun in degrees -''' - - -SOLAR_ELEVATION_PRESUNSET_POSTSUNRISE = 32.0 / 60.0 -''' -:float The Sun's elevation the beginning of sunset and - end of sunrise, measured in degrees -''' - -SOLAR_ELEVATION_SUNSET_SUNRISE = -32.0 / 60.0 -''' -:float The Sun's elevation the (end of) at sunset and - (beginning of) sunrise, measured in degrees -''' - -SOLAR_ELEVATION_CIVIL_DUSK_DAWN = -6.0 -''' -:float The Sun's elevation at civil dusk and civil - dawn, measured in degrees -''' - -SOLAR_ELEVATION_NAUTICAL_DUSK_DAWN = -12.0 -''' -:float The Sun's elevation at nautical dusk and - nautical dawn, measured in degrees -''' - -SOLAR_ELEVATION_AMATEUR_ASTRONOMICAL_DUSK_DAWN = -15.0 -''' -:float The Sun's elevation at amateur astronomical dusk - and amateur astronomical dawn, measured in degrees -''' - -SOLAR_ELEVATION_ASTRONOMICAL_DUSK_DAWN = -18.0 -''' -:float The Sun's elevation at astronomical dusk - and astronomical dawn, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_TWILIGHT = (-18.0, 0.0) -''' -:(float, float) The Sun's lowest and highest elevation during - all periods of twilight, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_CIVIL_TWILIGHT = (-6.0, SOLAR_ELEVATION_SUNSET_SUNRISE) -''' -:(float, float) The Sun's lowest and highest elevation - during civil twilight, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_NAUTICAL_TWILIGHT = (-12.0, SOLAR_ELEVATION_SUNSET_SUNRISE) -''' -:(float, float) The Sun's lowest and highest elevation - during nautical twilight, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_ASTRONOMICAL_TWILIGHT = (-18.0, SOLAR_ELEVATION_SUNSET_SUNRISE) -''' -:(float, float) The Sun's lowest and highest elevation during - astronomical twilight, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_AMATEUR_ASTRONOMICAL_TWILIGHT = (-18.0, -15.0) -''' -:(float, float) The Sun's lowest and highest elevation during - amateur astronomical twilight, measured in degrees -''' - -SOLAR_ELEVATION_RANGE_GOLDEN_HOUR = (-4.0, 6.0) -''' -:(float, float) The Sun's lowest and highest elevation during - the golden "hour" (also known as magic hour), - measured in degrees. These elevations are - approximate. -''' - -SOLAR_ELEVATION_RANGE_BLUE_HOUR = (-6.0, -4.0) -''' -:(float, float) The Sun's lowest and highest elevation during - the blue "hour", measured in degrees. These - elevations are approximate. -''' - - - -# The following functions are used to calculate the result for `sun` -# (most of them) but could be used for anything else. There name is -# should tell you enough, `t` (and `noon`) is in Julian Centuries -# except for in the convertion methods. - - -def julian_day_to_epoch(t): - ''' - Converts a Julian Day timestamp to a POSIX time timestamp - - @param t:float The time in Julian Days - @return :float The time in POSIX time - ''' - return (t - 2440587.5) * 86400.0 - - -def epoch_to_julian_day(t): - ''' - Converts a POSIX time timestamp to a Julian Day timestamp - - @param t:float The time in POSIX time - @return :float The time in Julian Days - ''' - return t / 86400.0 + 2440587.5 - - -def julian_day_to_julian_centuries(t): - ''' - Converts a Julian Day timestamp to a Julian Centuries timestamp - - @param t:float The time in Julian Days - @return :float The time in Julian Centuries - ''' - return (t - 2451545.0) / 36525.0 - - -def julian_centuries_to_julian_day(t): - ''' - Converts a Julian Centuries timestamp to a Julian Day timestamp - - @param t:float The time in Julian Centuries - @return :float The time in Julian Days - ''' - return t * 36525.0 + 2451545.0 - - -def epoch_to_julian_centuries(t): - ''' - Converts a POSIX time timestamp to a Julian Centuries timestamp - - @param t:float The time in POSIX time - @return :float The time in Julian Centuries - ''' - return julian_day_to_julian_centuries(epoch_to_julian_day(t)) - - -def julian_centuries_to_epoch(t): - ''' - Converts a Julian Centuries timestamp to a POSIX time timestamp - - @param t:float The time in Julian Centuries - @return :float The time in POSIX time - ''' - return julian_day_to_epoch(julian_centuries_to_julian_day(t)) - - -def epoch(): - ''' - Get current POSIX time - - @return :float The current POSIX time - ''' - import time - return time.time() - - -def julian_day(): - ''' - Get current Julian Day time - - @return :float The current Julian Day time - ''' - return epoch_to_julian_day(epoch()) - - -def julian_centuries(): - ''' - Get current Julian Centuries time (100 Julian days since J2000) - - @return :float The current Julian Centuries time - ''' - return epoch_to_julian_centuries(epoch()) - - -def radians(deg): - ''' - Convert an angle from degrees to radians - - @param deg:float The angle in degrees - @return :float The angle in radians - ''' - import math - return deg * math.pi / 180 - - -def degrees(rad): - ''' - Convert an angle from radians to degrees - - @param rad:float The angle in radians - @return :float The angle in degrees - ''' - import math - return rad * 180 / math.pi - - -def sun_geometric_mean_longitude(t): - ''' - Calculates the Sun's geometric mean longitude - - @param t:float The time in Julian Centuries - @return :float The Sun's geometric mean longitude in radians - ''' - return radians((0.0003032 * t ** 2 + 36000.76983 * t + 280.46646) % 360) - # CANNIBALISERS: - # The result of this function should always be positive, this - # means that after division modulo 360 but before `radians`, - # you will need to add 360 if the value is negative. This can - # only happen if `t` is negative, which can only happen for date - # times before 2000-(01)Jan-01 12:00:00 UTC par division modulo - # implementations with the signess of at least the left operand. - # More precively, it happens between circa 1970-(01)Jan-11 - # 16:09:02 UTC and circa 374702470660351740 seconds before - # January 1, 1970 00:00 UTC, which is so far back in time - # it cannot be reliable pinned down to the right year, but it - # is without a shadow of a doubt looooong before the Earth - # was formed, is right up there with the age of the Milky Way - # and the universe itself. - - -def sun_geometric_mean_anomaly(t): - ''' - Calculates the Sun's geometric mean anomaly - - @param t:float The time in Julian Centuries - @return :float The Sun's geometric mean anomaly in radians - ''' - return radians(-0.0001537 * t ** 2 + 35999.05029 * t + 357.52911) - - -def earth_orbit_eccentricity(t): - ''' - Calculates the Earth's orbit eccentricity - - @param t:float The time in Julian Centuries - @return :float The Earth's orbit eccentricity - ''' - return -0.0000001267 * t ** 2 - 0.000042037 * t + 0.016708634 - - -def sun_equation_of_centre(t): - ''' - Calculates the Sun's equation of the centre, the difference between - the true anomaly and the mean anomaly - - @param t:float The time in Julian Centuries - @return :float The Sun's equation of the centre, in radians - ''' - import math - a = sun_geometric_mean_anomaly(t) - rc = math.sin(1 * a) * (-0.000014 * t ** 2 - 0.004817 * t + 1.914602) - rc += math.sin(2 * a) * (-0.000101 * t + 0.019993) - rc += math.sin(3 * a) * 0.000289 - return radians(rc) - - -def sun_real_longitude(t): - ''' - Calculates the Sun's real longitudinal position - - @param t:float The time in Julian Centuries - @return :float The longitude, in radians - ''' - rc = sun_geometric_mean_longitude(t) - return rc + sun_equation_of_centre(t) - - -def sun_apparent_longitude(t): - ''' - Calculates the Sun's apparent longitudinal position - - @param t:float The time in Julian Centuries - @return :float The longitude, in radians - ''' - import math - rc = degrees(sun_real_longitude(t)) - 0.00569 - rc -= 0.00478 * math.sin(radians(-1934.136 * t + 125.04)) - return radians(rc) - - -def mean_ecliptic_obliquity(t): - ''' - Calculates the mean ecliptic obliquity of the Sun's - apparent motion without variation correction - - @param t:float The time in Julian Centuries - @return :float The uncorrected mean obliquity, in radians - ''' - rc = 0.001813 * t ** 3 - 0.00059 * t ** 2 - 46.815 * t + 21.448 - rc = 26 + rc / 60 - rc = 23 + rc / 60 - return radians(rc) - - -def corrected_mean_ecliptic_obliquity(t): - ''' - Calculates the mean ecliptic obliquity of the Sun's - apparent motion with variation correction - - @param t:float The time in Julian Centuries - @return :float The mean obliquity, in radians - ''' - import math - rc = -1934.136 * t + 125.04 - rc = 0.00256 * math.cos(radians(rc)) - rc += degrees(mean_ecliptic_obliquity(t)) - return radians(rc) - - -def solar_declination(t): - ''' - Calculates the Sun's declination - - @param t:float The time in Julian Centuries - @return :float The Sun's declination, in radians - ''' - import math - rc = math.sin(corrected_mean_ecliptic_obliquity(t)) - rc *= math.sin(sun_apparent_longitude(t)) - return math.asin(rc) - - -def equation_of_time(t): - ''' - Calculates the equation of time, the discrepancy - between apparent and mean solar time - - @param t:float The time in Julian Centuries - @return :float The equation of time, in degrees - ''' - import math - l = sun_geometric_mean_longitude(t) - e = earth_orbit_eccentricity(t) - m = sun_geometric_mean_anomaly(t) - y = corrected_mean_ecliptic_obliquity(t) - y = math.tan(y / 2) ** 2 - rc = y * math.sin(2 * l) - rc += (4 * y * math.cos(2 * l) - 2) * e * math.sin(m) - rc -= 0.5 * y ** 2 * math.sin(4 * l) - rc -= 1.25 * e ** 2 * math.sin(2 * m) - return 4 * degrees(rc) - - -def hour_angle_from_elevation(latitude, declination, elevation): - ''' - Calculates the solar hour angle from the Sun's elevation - - @param longitude:float The longitude in degrees eastwards - from Greenwich, negative for westwards - @param declination:float The declination, in radians - @param elevation:float The Sun's elevation, in radians - @return :float The solar hour angle, in radians - ''' - import math - if elevation == 0: - return 0 - rc = math.cos(abs(elevation)) - rc -= math.sin(radians(latitude)) * math.sin(declination) - rc /= math.cos(radians(latitude)) * math.cos(declination) - rc = math.acos(rc) - return -rc if (rc < 0) == (elevation < 0) else rc - - -def elevation_from_hour_angle(latitude, declination, hour_angle): - ''' - Calculates the Sun's elevation from the solar hour angle - - @param longitude:float The longitude in degrees eastwards - from Greenwich, negative for westwards - @param declination:float The declination, in radians - @param hour_angle:float The solar hour angle, in radians - @return :float The Sun's elevation, in radians - ''' - import math - rc = math.cos(radians(latitude)) - rc *= math.cos(hour_angle) * math.cos(declination) - rc += math.sin(radians(latitude)) * math.sin(declination) - return math.asin(rc) - - -def time_of_solar_noon(t, longitude): - ''' - Calculates the time of the closest solar noon - - @param t:float A time close to the sought time, - in Julian Centuries - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @return :float The time, in Julian Centuries, - of the closest solar noon - ''' - t, rc = julian_centuries_to_julian_day(t), longitude - for (k, m) in ((-360, 0), (1440, -0.5)): - rc = julian_day_to_julian_centuries(t + m + rc / k) - rc = 720 - 4 * longitude - equation_of_time(rc) - return rc - - -def time_of_solar_elevation(t, noon, latitude, longitude, elevation): - ''' - Calculates the time the Sun has a specified apparent - elevation at a geographical position - - @param t:float A time close to the sought time, - in Julian Centuries - @param noon:float The time of the closest solar noon - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param elevation:float The solar elevation, in radians - @return :float The time, in Julian Centuries, - of the specified elevation - ''' - rc = noon - rc, et = solar_declination(rc), equation_of_time(rc) - rc = hour_angle_from_elevation(latitude, rc, elevation) - rc = 720 - 4 * (longitude + degrees(rc)) - et - - rc = julian_day_to_julian_centuries(julian_centuries_to_julian_day(t) + rc / 1440) - rc, et = solar_declination(rc), equation_of_time(rc) - rc = hour_angle_from_elevation(latitude, rc, elevation) - rc = 720 - 4 * (longitude + degrees(rc)) - et - return rc - - -def solar_elevation_from_time(t, latitude, longitude): - ''' - Calculates the Sun's elevation as apparent - from a geographical position - - @param t:float The time in Julian Centuries - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @return :float The Sun's apparent elevation at the specified - time as seen from the specified position, - measured in radians - ''' - rc = julian_centuries_to_julian_day(t) - rc = (rc - float(int(rc + 0.5)) - 0.5) * 1440 - rc = 720 - rc - equation_of_time(t) - rc = radians(rc / 4 - longitude) - return elevation_from_hour_angle(latitude, solar_declination(t), rc) - - -def solar_elevation(latitude, longitude, t = None): - ''' - Calculates the Sun's elevation as apparent - from a geographical position - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float The Sun's apparent elevation at the specified - time as seen from the specified position, - measured in degrees - ''' - rc = julian_centuries() if t is None else t - rc = solar_elevation_from_time(rc, latitude, longitude) - return degrees(rc) - - - -def 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. - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param t:float? The time in Julian Centuries, `None` - for the current time - @return Whether there can be sunrises and - sunsets where you are located - ''' - t = julian_centuries() if t is None else t - d = degrees(solar_declination(t)) - ## Convert everything to the Northern hemisphere - latitude = abs(latitude) - if d >= 0: - ## Northern summer - return -90 + d < latitude < 90 - d - else: - ## Northern winter - return -90 - d < latitude < 90 + d - - -def is_summer(latitude, t = None): - ''' - Determine whether it is summer - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param t:float? The time in Julian Centuries, `None` - for the current time - @return Whether it is summer on the hemisphere - you are located on - ''' - t = julian_centuries() if t is None else t - d = solar_declination(t) - return (d > 0) == (latitude > 0) - - -def is_winter(latitude, t = None): - ''' - Determine whether it is winter - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param t:float? The time in Julian Centuries, `None` - for the current time - @return Whether it is winter on the hemisphere - you are located on - ''' - t = julian_centuries() if t is None else t - d = solar_declination(t) - return not ((d > 0) == (latitude > 0)) - - - -def 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 - - @param delta:float Iteration step size, negative for past - event, positive for future event - @param requested:float The value returned by `fun` for which to - calculate the time point of occurrence - @param fun:(t:float)→float Function that calculate the data of interest - @param epsilon:float The tolerance for the result - @param span:float The number of Julian Centuries (0,01 for - one year) to restrict the search to - @param t:float? The time in Julian Centuries, `None` for - the current time - @return :float? The calculated time point, `None` if none - were found within the specified time span - ''' - fun_ = lambda t : fun(t) - requested - t = julian_centuries() if t is None else t - t1 = t2 = t - v1 = v0 = fun_(t) - - # Predicate time point to within a small time span - while True: - if abs(t2 - t) > span: - return None - t2 += delta - v2 = fun_(t2) - if (v1 <= 0 <= v2) or ((0 >= v1 >= v2) and (0 <= v0)): - break - if (v1 >= 0 >= v2) or ((0 <= v1 <= v2) and (0 >= v0)): - break - t1 = t2 - v2 = v1 - - # Binary search the small time span for the exact time point - for _itr in range(1000): - tm = (t1 + t2) / 2 - v1 = fun_(t1) - v2 = fun_(t2) - vm = fun_(tm) - if abs(v1 - v2) < epsilon: - return tm - if v1 < v2: - if 0 < vm: - t2 = tm - else: - t1 = tm - elif v1 > v2: - if 0 > vm: - t2 = tm - else: - t1 = tm - return tm - - - -def future_past_equinox(delta, t = None): - ''' - Predict the time point of the next or previous equinox - - @param delta:float Iteration step size, negative for - past event, positive for future event - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float The calculated time point - ''' - return solar_prediction(delta, 0, solar_declination, t = t) - - -def future_equinox(t = None): - ''' - Predict the time point of the next equinox - - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float The calculated time point - ''' - return future_past_equinox(0.01 / 2000, t) - - -def past_equinox(t = None): - ''' - Predict the time point of the previous equinox - - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float The calculated time point - ''' - return future_past_equinox(0.01 / -2000, t) - - - -def future_past_solstice(delta, t = None): - ''' - Predict the time point of the next or previous solstice - - @param delta:float Iteration step size, negative for - past event, positive for future event - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float The calculated time point - ''' - e = 0.00001 - fun = solar_declination - dfun = lambda t : (fun(t + e) - fun(t - e)) / (2 * e) - return solar_prediction(delta, 0, dfun, t = t) - - -def future_solstice(t = None): - ''' - Predict the time point of the next solstice - - @param t:float? The time in Julian Centuries, - `None` for the current time - @return :float The calculated time point - ''' - return future_past_solstice(0.01 / 2000, t) - - -def past_solstice(t = None): - ''' - Predict the time point of the previous solstice - - @param t:float? The time in Julian Centuries, - `None` for the current time - @return :float The calculated time point - ''' - return future_past_solstice(0.01 / -2000, t) - - - -def future_past_elevation(delta, latitude, longitude, elevation, t = None): - ''' - Predict the time point of the next or previous time - the Sun reaches or reached a specific elevation - - @param delta:float Iteration step size, negative for past - event, positive for future event - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param elevation:float The elevation of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` if - none were found within a year - ''' - fun = lambda t : solar_elevation(latitude, longitude, t) - return solar_prediction(delta, elevation, fun, t = t) - - -def future_elevation(latitude, longitude, elevation, t = None): - ''' - Predict the time point of the next time the Sun - reaches a specific elevation - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param elevation:float The elevation of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` if - none were found within a year - ''' - return future_past_elevation(0.01 / 2000, latitude, longitude, elevation, t) - - -def past_elevation(latitude, longitude, elevation, t = None): - ''' - Predict the time point of the previous time the Sun - reached a specific elevation - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param elevation:float The elevation of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` if - none were found within a year - ''' - return future_past_elevation(0.01 / -2000, latitude, longitude, elevation, t) - - - -def future_past_elevation_derivative(delta, latitude, longitude, derivative, t = None): - ''' - Predict the time point of the next or previous time the - Sun reaches or reached a specific elevation derivative - - @param delta:float Iteration step size, negative for past - event, positive for future event - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param derivative:float The elevation derivative value of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` if - none were found within a year - ''' - e = 0.00001 - fun = lambda t : solar_elevation(latitude, longitude, t) - dfun = lambda t : (fun(t + e) - fun(t - e)) / (2 * e) - return solar_prediction(delta, derivative, dfun, t = t) - - -def future_elevation_derivative(latitude, longitude, derivative, t = None): - ''' - Predict the time point of the next time the - Sun reaches a specific elevation derivative - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param derivative:float The elevation derivative value of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` if - none were found within a year - ''' - return future_past_elevation_derivative(0.01 / 2000, latitude, longitude, derivative, t) - - -def past_elevation_derivative(latitude, longitude, derivative, t = None): - ''' - Predict the time point of the previous time - the Sun reached a specific elevation derivative - - @param latitude:float The latitude in degrees northwards from - the equator, negative for southwards - @param longitude:float The longitude in degrees eastwards from - Greenwich, negative for westwards - @param derivative:float The elevation derivative value of interest - @param t:float? The time in Julian Centuries, `None` - for the current time - @return :float? The calculated time point, `None` - if none were found within a year - ''' - return future_past_elevation_derivative(0.01 / -2000, latitude, longitude, derivative, t) - - - -# TODO: This algorithm is imprecise, gives an incorrent sunrise and I do not fully know its behaviour -def sunrise_equation(latitude, longitude, t = None): - import math - # Calculate Julian Cycle - j_cent = julian_centuries() if t is None else t - j_date = julian_centuries_to_julian_day(j_cent) - j_cycle = int(j_date - 2451545.0009 - longitude / 360 + 0.5) - - # Calculate approximate solar noon and solar man anomaly - approx_solar_noon = 451545.0009 + longitude / 360 + j_cycle - solar_mean_anomaly = int(357.5291 + 0.98560028 * (j_cycle - 2451545)) % 360 - - # Calculate solar equation of centre - equation_of_centre = 1.9148 * math.sin(1 * solar_mean_anomaly) - equation_of_centre += 0.0200 * math.sin(2 * solar_mean_anomaly) - equation_of_centre += 0.0003 * math.sin(3 * solar_mean_anomaly) - - # Calculate solar ecliptic longitude - ecliptic_longitude = (solar_mean_anomaly + 102.9372 + equation_of_centre + 180) % 360 - - # Calculate solar transit - solar_transit = approx_solar_noon + 0.0053 * math.sin(solar_mean_anomaly) - solar_transit -= 0.0069 * math.sin(2 * ecliptic_longitude) - - # Calculate solar declination - declination = math.asin(math.sin(ecliptic_longitude) * math.sin(radians(23.45))) - - # Calculate solar hour angle - hour_angle = math.sin(radians(-0.83)) - hour_angle -= math.sin(latitude) * math.sin(declination) - hour_angle /= math.cos(latitude) * math.cos(declination) - hour_angle = degrees(math.acos(hour_angle)) - - # Calculate time of sunset and sunrise - sunset = 2451545.0009 + (hour_angle + longitude) / 360 - sunset += j_cycle + solar_transit - approx_solar_noon - sunrise = 2 * solar_transit - sunset - - # Convert to Julian Centuries - return (julian_day_to_julian_centuries(sunset), - julian_day_to_julian_centuries(sunrise)) - -- cgit v1.2.3-70-g09d2