Skip to content

Commit

Permalink
fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
@hamiltoncj
hamiltoncj committed Aug 29, 2023
1 parent f2a1473 commit 0517b02
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 15 deletions.
12 changes: 6 additions & 6 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,18 @@
</head>
<body>
<h1>Earth, Sun, Moon, and Planets Plugin</h1>
<p>This plugin uses the highly accurate Skyfield library to show where the sun, moon, and planets are located at their zenith from earth's perspective for a particular date and time. An additional algorithm calculates lunar and solar data for a particular location on earth given a date and time. The <strong><em>Day/Night terminator</em></strong> algorithm plots the day/night terminator line and polygon layers associate with sunrise/set, civil twilight, nautical twilight, and astronomical twilight. When installed, this plugin can be found in the QGIS menu under <strong><em>Plugins-&gt;Earth, sun, moon &amp; planets</em></strong>. </p>
<p>This plugin uses the highly accurate Skyfield library to show where the sun, moon, and planets are located at their zenith from earth's perspective for a particular date and time. An additional algorithm calculates lunar and solar data for a particular location on earth given a date and time. The <strong><em>Day/Night terminator</em></strong> algorithm plots the day/night terminator line and polygon layers associated with sunrise/sunset, civil twilight, nautical twilight, and astronomical twilight. When installed, this plugin can be found in the QGIS menu under <strong><em>Plugins-&gt;Earth, sun, moon &amp; planets</em></strong>. </p>
<div style="text-align:center"><img src="doc/menu.jpg" alt="Plugin menu"></div>

<h2>Installation</h2>
<p>This plugin requires two additional libraries not provided by QGIS except for the <strong><em>Day/Night terminator</em></strong> and <strong><em>Sun position directly overhead</em></strong> algorithms. These libraries can be installed by running the OSGeo4W Shell and typing the command "<strong>pip install timezonefinder skyfield</strong>" or whatever method you use to install Python libraries.</p>
<p>This plugin can be enhanced with two additional python libraries not provided by QGIS. Without the extra libraries only the <strong><em>Day/Night terminator</em></strong> and <strong><em>Sun position directly overhead</em></strong> algorithms will be available. These libraries can be installed by running the OSGeo4W Shell and typing the command "<strong>pip install timezonefinder skyfield</strong>" or whatever method you use to install Python libraries.</p>
<p>You do not need to be a system administrator to be able to install these libraries. If these libraries are not installed then the functionality will be limited to the following two capabilities.</p>
<div style="text-align:center"><img src="doc/menu_limited.jpg" alt="Plugin menu"></div>

<h2>Tools Overview</h2>
<p>These are the tools provided by the Earth, Sun, Moon, and Planets Plugin:</p>
<ul>
<li><img src="icons/daynight.png" width=24 height=24 alt="Day/Night terminator"> <strong><em>Day/Night terminator</em></strong> - This algorithm creates vector layers for the day/night terminator line, polygon layers associate with sunrise/set, civil twilight, nautical twilight and astronomical twilight, and the position of the sun directly overhead. Unlike the other algorithms below this does not depend on the Skyfield library. It uses spherical geometry like the web based maps that you find on-line.</li>
<li><img src="icons/daynight.png" width=24 height=24 alt="Day/Night terminator"> <strong><em>Day/Night terminator</em></strong> - This algorithm creates vector layers for the day/night terminator line, polygon layers associated with sunrise/sunset, civil twilight, nautical twilight and astronomical twilight, and the position of the sun directly overhead. Unlike the other algorithms below this does not depend on the Skyfield library. It uses spherical geometry like the web based maps that you find on-line.</li>
<li><img src="icons/sun_icon.svg" alt="Sun position directly overhead"> <strong><em>Sun position directly overhead</em></strong> - This shows the location of the sun where it is directly overhead for a particular date and time. If the Skyfield library is not installed, then this algorithm uses a slightly less accurate spherical calculation for the sun's position.</li>
<li><img src="icons/moon.png" width=24 height=24 alt="Moon position directly overhead"> <strong><em>Moon position directly overhead</em></strong> - This shows the location of the moon where it is directly overhead for a particular date and time.</li>
<li><img src="icons/venus.png" width=24 height=24 alt="Planetary positions directly overhead"> <strong><em>Planetary positions directly overhead</em></strong> - This shows the location of the planets where they are directly overhead for a particular date and time.</li>
Expand All @@ -67,10 +67,10 @@ <h2><img src="icons/daynight.png" width=24 height=24 alt="Day/Night terminator">
* <strong><em>Civil Twilight</em></strong> - This is a polygon of the civil twilight region.
* <strong><em>Nautical Twilight</em></strong> - This is a polygon of the nautical twilight region.
* <strong><em>Astronomical Twilight</em></strong> - This is a polygon of the astronomical twilight region.
* <strong><em>Delta/resolution of polygon</em></strong> - This determines the number of points used to create the lines and polygons. The larger the number the less accurate it will be. The default value of 1.0 probably does not need to be changed in most instances.
* <strong><em>Add solar disk diameter for day/night terminator calculation</em></strong> - The sun is not a point but a disk and this compensates for the day/night terminator with a refraction index of 0.833. What is most accurate? It really depends on your definition of the day/night terminator line. By default this is not checked.
* <strong><em>Delta/resolution of polygon</em></strong> - This determines the number of points used to create the lines and polygons. A larger number means fewer points and less accuracy. The default value of 1.0 probably does not need to be changed in most instances.
* <strong><em>Add solar disk diameter for day/night terminator calculation</em></strong> - The sun is not a point but a disk and this compensates for the day/night terminator with a refraction index of 0.833. Should you check this box? It really depends on your definition of the day/night terminator line. By default it is not checked.
* <strong><em>Automatically style output</em></strong> - When checked, the resulting output layers are nicely styled.
* <strong><em>Clip polygons to project CRS bounds</em></strong> - The output vector layers coordinate reference is EPSG:4326 with longitude going from -180 to 180 degrees and latitude from -90 to 90 degrees. If you are using some other CRS and this is checked, then the resulting layers will be clipped to the project CRS.</p>
* <strong><em>Clip polygons to project CRS bounds</em></strong> - The output vector layer's coordinate reference is EPSG:4326 with longitude going from -180 to 180 degrees and latitude from -90 to 90 degrees. If you are using some other CRS and this is checked, then the resulting layers will be clipped to the project CRS.</p>
<p>Here is an example of what is generated with automatic styling.</p>
<div style="text-align:center"><img src="doc/day_night.jpg" alt="Day/Night"></div>

Expand Down
7 changes: 4 additions & 3 deletions metadata.txt
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[general]
name=Earth, Sun, Moon, and Planets
qgisMinimumVersion=3.14
description=Tools to calculate the positions of the sun, moon, and planets when viewed from directly overhead for a particular date and time. It displays solar and lunar information for a coordinate at the specified date and time. (Note the Python library enhancements.)
version=3.0.3
description=Tools to calculate the positions of the sun, moon, and planets when viewed directly overhead for a particular date and time. Create day/night terminator vector layers. Display solar and lunar information for a coordinate at the specified date and time. (Note the Python library enhancements.)
version=3.0.4
author=C Hamilton
[email protected]
about=
Enhance this plugin with two Python libraries not provided by the QGIS distribution. Open up the OSGeo4W Shell and type "pip install timezonefinder skyfield" or whatever method you use to install Python libraries. You don't need to be a system administrator to do this. Without adding in these libraries, the only algorithms available are the "Day/Night terminator" and "Sun position directly overhead"

This plugin provides tools to calculate the positions of the sun, moon, and planets when viewed from directly overhead for a particular date and time. It displays solar and lunar information for a coordinate at the specified date and time. It will produce the day/night terminator line, and twlight polygons.
This plugin provides tools to calculate the positions of the sun, moon, and planets when viewed directly overhead for a particular date and time. It displays solar and lunar information for a coordinate at the specified date and time. It will produce the day/night terminator line, and twilight polygons.
tracker=https://github.com/NationalSecurityAgency/qgis-earthsunmoon-plugin/issues
repository=https://github.com/NationalSecurityAgency/qgis-earthsunmoon-plugin
tags=time,conversion,sun,moon,planet,planets,date,dawn,sunrise,noon,sunset,dusk,weekday,mercury,venus,earth,mars,jupiter,saturn,uranus,neptune,pluto,terminator line,astornomical,civil,nautical,twilight
Expand All @@ -19,6 +19,7 @@ experimental=False
deprecated=False
hasProcessingProvider=yes
changelog=
3.0.4 - Fix typos
3.0.3 - Add day/night boundry lines and polygons
3.0.2 - Fix to allow qgis_process to function correctly.
3.0.1 - Fix exception when libraries are not installed
Expand Down
12 changes: 6 additions & 6 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Earth, Sun, Moon, and Planets Plugin

This plugin uses the highly accurate Skyfield library to show where the sun, moon, and planets are located at their zenith from earth's perspective for a particular date and time. An additional algorithm calculates lunar and solar data for a particular location on earth given a date and time. The ***Day/Night terminator*** algorithm plots the day/night terminator line and polygon layers associate with sunrise/set, civil twilight, nautical twilight, and astronomical twilight. When installed, this plugin can be found in the QGIS menu under ***Plugins->Earth, sun, moon &amp; planets***.
This plugin uses the highly accurate Skyfield library to show where the sun, moon, and planets are located at their zenith from earth's perspective for a particular date and time. An additional algorithm calculates lunar and solar data for a particular location on earth given a date and time. The ***Day/Night terminator*** algorithm plots the day/night terminator line and polygon layers associated with sunrise/sunset, civil twilight, nautical twilight, and astronomical twilight. When installed, this plugin can be found in the QGIS menu under ***Plugins->Earth, sun, moon &amp; planets***.

<div style="text-align:center"><img src="doc/menu.jpg" alt="Plugin menu"></div>

## Installation
This plugin requires two additional libraries not provided by QGIS except for the ***Day/Night terminator*** and ***Sun position directly overhead*** algorithms. These libraries can be installed by running the OSGeo4W Shell and typing the command "**pip install timezonefinder skyfield**" or whatever method you use to install Python libraries.
This plugin can be enhanced with two additional python libraries not provided by QGIS. Without the extra libraries only the ***Day/Night terminator*** and ***Sun position directly overhead*** algorithms will be available. These libraries can be installed by running the OSGeo4W Shell and typing the command "**pip install timezonefinder skyfield**" or whatever method you use to install Python libraries.

You do not need to be a system administrator to be able to install these libraries. If these libraries are not installed then the functionality will be limited to the following two capabilities.

Expand All @@ -15,7 +15,7 @@ You do not need to be a system administrator to be able to install these librari

These are the tools provided by the Earth, Sun, Moon, and Planets Plugin:

* <img src="icons/daynight.png" width=24 height=24 alt="Day/Night terminator"> ***Day/Night terminator*** - This algorithm creates vector layers for the day/night terminator line, polygon layers associate with sunrise/set, civil twilight, nautical twilight and astronomical twilight, and the position of the sun directly overhead. Unlike the other algorithms below this does not depend on the Skyfield library. It uses spherical geometry like the web based maps that you find on-line.
* <img src="icons/daynight.png" width=24 height=24 alt="Day/Night terminator"> ***Day/Night terminator*** - This algorithm creates vector layers for the day/night terminator line, polygon layers associated with sunrise/sunset, civil twilight, nautical twilight and astronomical twilight, and the position of the sun directly overhead. Unlike the other algorithms below this does not depend on the Skyfield library. It uses spherical geometry like the web based maps that you find on-line.
* <img src="icons/sun_icon.svg" alt="Sun position directly overhead"> ***Sun position directly overhead*** - This shows the location of the sun where it is directly overhead for a particular date and time. If the Skyfield library is not installed, then this algorithm uses a slightly less accurate spherical calculation for the sun's position.
* <img src="icons/moon.png" width=24 height=24 alt="Moon position directly overhead"> ***Moon position directly overhead*** - This shows the location of the moon where it is directly overhead for a particular date and time.
* <img src="icons/venus.png" width=24 height=24 alt="Planetary positions directly overhead"> ***Planetary positions directly overhead*** - This shows the location of the planets where they are directly overhead for a particular date and time.
Expand All @@ -36,10 +36,10 @@ The input parameters are as follows:
* ***Civil Twilight*** - This is a polygon of the civil twilight region.
* ***Nautical Twilight*** - This is a polygon of the nautical twilight region.
* ***Astronomical Twilight*** - This is a polygon of the astronomical twilight region.
* ***Delta/resolution of polygon*** - This determines the number of points used to create the lines and polygons. The larger the number the less accurate it will be. The default value of 1.0 probably does not need to be changed in most instances.
* ***Add solar disk diameter for day/night terminator calculation*** - The sun is not a point but a disk and this compensates for the day/night terminator with a refraction index of 0.833. What is most accurate? It really depends on your definition of the day/night terminator line. By default this is not checked.
* ***Delta/resolution of polygon*** - This determines the number of points used to create the lines and polygons. A larger number means fewer points and less accuracy. The default value of 1.0 probably does not need to be changed in most instances.
* ***Add solar disk diameter for day/night terminator calculation*** - The sun is not a point but a disk and this compensates for the day/night terminator with a refraction index of 0.833. Should you check this box? It really depends on your definition of the day/night terminator line. By default it is not checked.
* ***Automatically style output*** - When checked, the resulting output layers are nicely styled.
* ***Clip polygons to project CRS bounds*** - The output vector layers coordinate reference is EPSG:4326 with longitude going from -180 to 180 degrees and latitude from -90 to 90 degrees. If you are using some other CRS and this is checked, then the resulting layers will be clipped to the project CRS.
* ***Clip polygons to project CRS bounds*** - The output vector layer's coordinate reference is EPSG:4326 with longitude going from -180 to 180 degrees and latitude from -90 to 90 degrees. If you are using some other CRS and this is checked, then the resulting layers will be clipped to the project CRS.

Here is an example of what is generated with automatic styling.

Expand Down

0 comments on commit 0517b02

Please sign in to comment.