Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adokter/suntools
R package to calculate sun position, sunrise, sunset, solar noon and twilight
https://github.com/adokter/suntools
Last synced: about 2 months ago
JSON representation
R package to calculate sun position, sunrise, sunset, solar noon and twilight
- Host: GitHub
- URL: https://github.com/adokter/suntools
- Owner: adokter
- License: gpl-3.0
- Created: 2023-05-16T19:05:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-05T17:02:26.000Z (over 1 year ago)
- Last Synced: 2024-06-26T11:44:12.174Z (6 months ago)
- Language: R
- Homepage:
- Size: 109 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# suntools
[](https://github.com/adokter/suntools/actions/workflows/R-CMD-check.yaml)
suntools provides functions for calculating the sun's position, sunrise, sunset, solar noon, and crepuscular (twilight)
times for any given geographical location and time on earth. Functions in suntools used to be part
of the [maptools](https://CRAN.R-project.org/package=maptools) package.
The functions are based on equations provided by the National Oceanic & Atmospheric Administration (NOAA).
Main package functions:
* `crepuscule()`: Calculates crepuscular (twilight) times, i.e. the time of dawn or dusk.
* `sunriset()`: Calculates the times of sunrise and sunset at a given location.
* `solarpos()`: Calculates the solar position (elevation and azimuth) at a given location and time.
* `solarnoon()`: Calculates solar noon time at a given location.
## Installation
You can install the released version of suntools from [CRAN](https://CRAN.R-project.org/) with:
``` r
install.packages("suntools")
```
Alternatively, you can install the development version from [GitHub](https://github.com/) with:
``` r
devtools::install_github("adokter/suntools")
```
## Example
``` r
library(suntools)
#Calculate sunset in Ithaca, NY, USA on June 1, 2023
sunriset(
matrix(c(-76.4511, 42.4800), nrow = 1),
as.POSIXct("2023-06-01", tz = "America/New_York"),
direction='sunset',
POSIXct.out=TRUE
)
# day_frac time
#1 0.858628 2023-06-01 20:36:25
```
## Author(s)
- Greg Pelletier ([[email protected]](mailto:[email protected])) - Original VBA code available from [Ecology WA Gov: Models & Tools for TMDLs](https://ecology.wa.gov/Research-Data/Data-resources/Models-spreadsheets/Modeling-the-environment/Models-tools-for-TMDLs), who in turn translated it from original Javascript code by NOAA
- Sebastian P. Luque ([[email protected]](mailto:[email protected])), translated from Greg Pelletier's code
- Roger Bivand ([[email protected]](mailto:[email protected])) adapted the code to work with sp classes.
- Adriaan M. Dokter ([[email protected]](mailto:[email protected])) adapted the code to work with sf classes.
- Pieter Huijbrechts ([[email protected]](mailto:[email protected])) set up continuous integration and automated tests.
- Alexander Tedeschi ([[email protected]](mailto:[email protected])) made tests and documentation roxygen compatible
## References
This package uses algorithms provided by the National Oceanic & Atmospheric Administration (NOAA), for more information see
* Meeus, J. (1991) Astronomical Algorithms. Willmann-Bell, Inc.
* NOAA's [Sunrise/Sunset Calculator](https://gml.noaa.gov/grad/solcalc/sunrise.html)
* NOAA's [Solar Position Calculator](https://gml.noaa.gov/grad/solcalc/azel.html)
* NOAA'S [Solar Calculation Details](https://gml.noaa.gov/grad/solcalc/calcdetails.html)