Data

Tools

Indexes

Applications

Experiments

Open Source Science

suncalc

R package for calculating sun/moon positions and phases, linked to suncalc.js

https://github.com/datastorm-open/suncalc

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.0%) to scientific vocabulary
Last synced: 11 months ago · JSON representation

Repository

R package for calculating sun/moon positions and phases, linked to suncalc.js

Basic Info
  • Host: GitHub
  • Owner: datastorm-open
  • License: other
  • Language: R
  • Default Branch: master
  • Size: 57.6 KB
Statistics
  • Stars: 43
  • Watchers: 5
  • Forks: 10
  • Open Issues: 5
  • Releases: 3
Created about 9 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

CRAN Status Badge CRAN Downloads Badge

suncalc

R implementation for calculating sun position, sunlight phases (times for sunrise, sunset, dusk, etc.), moon position and lunar phase for the given location and time. Most calculations are based on the formulas given in Astronomy Answers articles about position of the sun and the planets : https://www.aa.quae.nl/en/reken/zonpositie.html

News

0.5.0 dev version

  • fully recode in R rather than call suncalc.js, so up to 500x faster...!

Installation

````

from cran

install.packages("suncalc") devtools::install_github("datastorm-open/suncalc") for developpement version ````

Use

require(suncalc) ?getSunlightTimes getSunlightTimes(date = Sys.Date(), lat = 50.1, lon = 1.83, tz = "CET")

About suncalc

Most calculations are based on the formulas given in the excellent Astronomy Answers articles about position of the sun and the planets. You can read about different twilight phases calculated by SunCalc in the Twilight article on Wikipedia.

Reference

Sunlight times

Returns an object with the following properties (each is a Date object):

| Property | Description | | --------------- | ------------------------------------------------------------------------ | | sunrise | sunrise (top edge of the sun appears on the horizon) | | sunriseEnd | sunrise ends (bottom edge of the sun touches the horizon) | | goldenHourEnd | morning golden hour (soft light, best time for photography) ends | | solarNoon | solar noon (sun is in the highest position) | | goldenHour | evening golden hour starts | | sunsetStart | sunset starts (bottom edge of the sun touches the horizon) | | sunset | sunset (sun disappears below the horizon, evening civil twilight starts) | | dusk | dusk (evening nautical twilight starts) | | nauticalDusk | nautical dusk (evening astronomical twilight starts) | | night | night starts (dark enough for astronomical observations) | | nadir | nadir (darkest moment of the night, sun is in the lowest position) | | nightEnd | night ends (morning astronomical twilight starts) | | nauticalDawn | nautical dawn (morning nautical twilight starts) | | dawn | dawn (morning nautical twilight ends, morning civil twilight starts) |

Sun position

Returns an object with the following properties:

  • altitude: sun altitude above the horizon in radians, e.g. 0 at the horizon and PI/2 at the zenith (straight over your head)
  • azimuth: sun azimuth in radians (direction along the horizon, measured from south to west), e.g. 0 is south and Math.PI * 3/4 is northwest

Moon position

Returns an object with the following properties:

  • altitude: moon altitude above the horizon in radians
  • azimuth: moon azimuth in radians
  • distance: distance to moon in kilometers
  • parallacticAngle: parallactic angle of the moon in radians

Moon illumination

Returns an object with the following properties:

  • fraction: illuminated fraction of the moon; varies from 0.0 (new moon) to 1.0 (full moon)
  • phase: moon phase; varies from 0.0 to 1.0, described below
  • angle: midpoint angle in radians of the illuminated limb of the moon reckoned eastward from the north point of the disk; the moon is waxing if the angle is negative, and waning if positive

Moon phase value should be interpreted like this:

| Phase | Name | | -----:| --------------- | | 0 | New Moon | | | Waxing Crescent | | 0.25 | First Quarter | | | Waxing Gibbous | | 0.5 | Full Moon | | | Waning Gibbous | | 0.75 | Last Quarter | | | Waning Crescent |

By subtracting the parallacticAngle from the angle one can get the zenith angle of the moons bright limb (anticlockwise). The zenith angle can be used do draw the moon shape from the observers perspective (e.g. moon lying on its back).

Moon rise and set times

Returns an object with the following properties:

  • rise: moonrise time as Date
  • set: moonset time as Date
  • alwaysUp: true if the moon never rises/sets and is always above the horizon during the day
  • alwaysDown: true if the moon is always below the horizon

By default, it will search for moon rise and set during local user's day (frou 0 to 24 hours). If inUTC is set to true, it will instead search the specified date from 0 to 24 UTC hours.

Owner

  • Name: DataStorm
  • Login: datastorm-open
  • Kind: organization
  • Email: open-source@datastorm.fr
  • Location: Paris, France

DataStorm Open Project

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 2
Last Year
  • Watch event: 2
  • Issue comment event: 2

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 29
  • Total Committers: 4
  • Avg Commits per committer: 7.25
  • Development Distribution Score (DDS): 0.552
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Benoit Thieurmel b****l@g****m 13
Benoit Thieurmel b****l@d****r 11
aelmar a****r@g****m 4
Anders E Bilgrau a****u@g****m 1
Committer Domains (Top 20 + Academic)
datastorm.fr: 1

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 12
  • Total pull requests: 5
  • Average time to close issues: over 1 year
  • Average time to close pull requests: about 2 months
  • Total issue authors: 12
  • Total pull request authors: 5
  • Average comments per issue: 2.33
  • Average comments per pull request: 0.6
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • pepijn-devries (1)
  • danielvartan (1)
  • trashbirdecology (1)
  • tvqt (1)
  • mfidino (1)
  • karagawa (1)
  • paulr-bv (1)
  • dmi3kno (1)
  • bardolater (1)
  • brunomioto (1)
  • yvanrichard (1)
  • mdwhitby (1)
Pull Request Authors
  • mstrimas (1)
  • AchrafElmar (1)
  • AEBilgrau (1)
  • tuberculo (1)
  • bthieurmel (1)
Top Labels
Issue Labels
enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 2,991 last-month
  • Total dependent packages: 10
  • Total dependent repositories: 21
  • Total versions: 6
  • Total maintainers: 1
cran.r-project.org: suncalc

Compute Sun Position, Sunlight Phases, Moon Position and Lunar Phase

  • Versions: 6
  • Dependent Packages: 10
  • Dependent Repositories: 21
  • Downloads: 2,991 Last month
Rankings
Dependent packages count: 5.4%
Dependent repos count: 6.1%
Average: 6.9%
Forks count: 7.4%
Stargazers count: 7.6%
Downloads: 8.0%
Maintainers (1)
bthieurmel@gmail.com
Last synced: 12 months ago

Dependencies

DESCRIPTION cran
  • data.table * imports
  • lubridate * imports
  • magrittr * imports