Giter VIP home page Giter VIP logo

solar's Introduction

Solar

Version

A Swift helper for generating Sunrise and Sunset times. Swift 3 compatible.

Solar uses an algorithm from the United States Naval Observatory for its calculations.

Usage

Solar needs a date, a timezone and a location specified in latitude and longitude coordinates:

let solar = Solar(withTimeZone: NSTimeZone.localTimeZone(), latitude: 51.528308, longitude: -0.1340267)
let sunrise = solar.sunrise
let sunset = solar.sunset

If no date is specified, today is used by default. If no timezone is specified, the device's local timezone is used by default.

Timezones

When using Solar, all dates are returned in UTC. This means that for timezones other than GMT, the time will appear off. Don't forget to convert your date into the appropriate timezone.

Types of sunrise and sunset

  • Official
  • Civil
  • Nautical
  • Astromonical

Convenience methods

Solar also comes packaged with some convenience methods:

let isDaytime = solar.isDaytime()
let isNighttime = solar.isNighttime()

Installation

Solar is available through CocoaPods. To install, simply add the following line to your podfile:

pod "Solar"

Then run pod install

Todo:

  • Documentation
  • Unit tests

Future enhancements:

  • Calculate more variables relating to solar activity, i.e. Moonrise, Moonset, Moon luminosity.

License

The MIT License (MIT)

Copyright (c) 2016 Chris Howell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

solar's People

Contributors

ceek avatar readmecritic avatar

Watchers

James Cloos avatar Farhad Rismanchian avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.