timesteps 0.9.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9b039e00dac34bb9cf616ea94da9465feb696179d550c1b6f7f511ddf06756f
+  data.tar.gz: ac64b576636a5d9f45bbca34fd21ea479911a4dc260df2ef5a3adb2b5071ae6d
+SHA512:
+  metadata.gz: 237fa23fec58640aa1ab3ec9863a8f546016bc978d1b5258e5d5021fb875a55115696a3fb387dd4dc42e47cc561530b3de83604cf4cb7e2f708748183a011c67
+  data.tar.gz: 978d9e97ced5f11868018fc895fddb261eaf402e937a1371f0395c5f13c857dd1b3122d4e412cc723717fae8860a396fad804ffe316c80277c2516ed79b6de2e

data/LICENSES

@@ -0,0 +1,22 @@
+Copyright (c) 2020 Hiroki Motoyoshi.
+
+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.

data/Note.ja.md

@@ -0,0 +1,76 @@
+# メモ
+### 時間の単位 (udunits)
+    * years, year
+    * months,month
+    * days, day, d
+    * hours, hour, h
+    * minutes, minute, min
+    * seconds, sec, s
+
+### クラス構成
+
+#### DateTime, DateTimeLikeクラス
+	  class DateTime
+      module ParseTimeStampExt  ### DateTime(-like)クラスに、`parse_timestamp`を追加する
+	    module TimeStepsCustomExt ### TimeSteps用のDateTime refinement
+	    extend ParseTimeStampExtension
+    class DateTimeLike
+      module DateTimeLikeExtension ### NoLeap,AllLeap,Fixed360共通のクラスメソッドを追加する
+	  class DateTime::NoLeap < DateTimeLike
+      extend  ParseTimeStampExtension
+      extend  DateTimeLikeExtension
+    class DateTime::AllLeap < DateTimeLike
+      extend  ParseTimeStampExtension
+      extend  DateTimeLikeExtension
+    class DateTime::Fixed360Day < DateTimeLike
+      extend  ParseTimeStampExtension
+      extend  DateTimeLikeExtension
+
+#### TimeStep, TimeStepsPair, TimeStepConverter クラス
+    + class TimeSteps
+	      using DateTime::TimeStepsCustomExt
+    + class TimeSteps::Calendar
+	      using DateTime::TimeStepsCustomExt	
+    + class TimeStepsConv
+	      using DateTime::TimeStepsCustomExt
+        
+### DateTimeのユリウス日の起算日
+    -4712-01-01 00:00:00+00:00
+
+### UDUnits-2との非互換性（CF-規約との非互換性）
+    udunits-2は日にちの表式にBCを用いている。
+      TimeSteps.newのbcオプションでparsingには対応しているものの、time_atなどで返されるDateTimeオブジェクトは
+      BCを考慮していない点に注意。
+
+    DateTime.parse_timestamp(spec, bc: true)
+    TimeSteps#parse(spec)            (initialized with bc: option)
+    TimeSteps::Calendar#parse(spec)  (initialized with bc: option)
+
+### 暦の種類
+#### standard, gregorian
+
+* 今日使われているグレゴリオ暦 
+* 1582年10月4日の翌日が1582年10月15日と
+　することでユリウス暦で数えすぎたうるう日をスキップしている
+* 1582年10月15日以降はグレゴリオ暦のうるう年ルールを採用
+* 1582年10月4日以前はユリウス暦のうるう年ルールを採用
+
+#### proleptic_gregorian
+
+* 1582年10月15日以前もグレゴリオ暦のうるう年ルールを採用
+
+#### proleptic_julian, julian
+
+* 1582年10月4日以降もユリウス暦のうるう年ルールを採用
+
+#### noleap, 365_day
+
+* すべての年はうるう年ではないものとした暦
+
+#### allleap, 366_day
+
+* すべての年はうるう年であるとした暦
+
+#### 360_day
+
+* すべての月が30日であるとした暦

data/README.md

@@ -0,0 +1,57 @@
+timesteps
+================
+
+A library for handling discrete time series in constant increments.
+The main purpose of this library is to describe the time axis 
+when dealing with time series of observational data and climate data.
+
+Features
+--------
+
+* TimeStep consists of a pair of origin time and a time interval.
+* An instance of a TimeStep can be constructed by parsing an expression like "hours since 2001-01-01 00:00:00" (originate from udunits library)
+* DateTime object can be obtained from the index value (0 for the origin time).
+* The index value can be calculated from the date and time.
+* TimeStep can handle special calendar-type time series such as noleap, allleap, and 360_day.
+* "24:00:00" can be parsed as a valid timestamp.
+* You can pairert the index values between different TimeStep instances using TimeStepConv.
+
+Usage
+-----
+
+### TimeStep
+
+```ruby
+require "timesteps"
+
+ts = TimeStep.new("3 hours since 2001-01-01 09:00:00", calendar: "standard")
+
+p ts                ### => #<TimeStep definition='3 hours since 2001-01-01 09:00:00.000000000 +00:00' calendar='standard'>
+  
+p ts.origin         ### => #<DateTime: 2001-01-01T09:00:00+00:00 ...>
+
+p ts.time_at(1)     ### => #<DateTime: 2001-01-01T12:00:00+00:00 ...>
+p ts.time_at(8)     ### => #<DateTime: 2001-01-02T09:00:00+00:00 ...>
+
+time = DateTime.parse("2001-01-02 09:00:00 +00:00")
+p ts.index_at(time) ### => (8/1)    <Rational>
+```
+
+### TimeStepPair
+
+```ruby
+require "timesteps"
+
+ts1 = TimeStep.new("3 hours since 2001-01-01 21:00:00")
+ts2 = TimeStep.new("hour since 2001-01-01 09:00:00")
+pair = TimeStep::Pair.new(ts1, ts2)
+
+p pair            ### => <TimeStepConv from='<TimeSteps unit='3 hour since 2001-01-01 21:00:00.000000000' calendar='standard'>' to='<TimeSteps unit='hour since 2001-01-01 09:00:00.000000000' calendar='standard'>'>
+  
+p pair.forward(0) ### 12/1  (12)
+p pair.forward(2) ### 18/1  (12 + 2*3h/1h)
+
+p pair.inverse(0) ### -4/1  ((-12h)/3h)
+p pair.inverse(2) ### -10/3 ((-12h+2*1h)/3h)
+```
+

data/Rakefile

@@ -0,0 +1,11 @@
+GEMSPEC = "timesteps.gemspec"
+
+task :install do
+  spec = eval File.read(GEMSPEC)
+  system %{
+    gem build #{GEMSPEC}; gem install #{spec.full_name}.gem
+  }
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/lib/timesteps/calendar.rb

@@ -0,0 +1,104 @@
+
+class TimeStep
+
+  class Calendar
+
+    using TimeStep::DateTimeExt
+
+    # @private
+    SYM_365_day = "365_day".intern
+    # @private
+    SYM_366_day = "366_day".intern
+    # @private
+    SYM_360_day = "360_day".intern
+
+    def initialize (calendar = "standard", bc: false)
+      @name     = calendar
+      @bc       = bc
+      case @name.downcase.intern
+      when :standard, :gregorian
+        @calendar = :standard
+      when :proleptic_gregorian
+        @calendar = :proleptic_gregorian
+      when :proleptic_julian, :julian
+        @calendar = :proleptic_julian
+      when :noleap, SYM_365_day
+        @calendar = :noleap
+      when :allleap, SYM_366_day
+        @calendar = :allleap
+      when SYM_360_day
+        @calendar = SYM_360_day
+      end
+    end
+    
+    attr_reader :name, :calendar
+    
+    def == (other)
+      return @calendar == other.calendar && bc? == other.bc?
+    end
+    
+    def bc?
+      return @bc ? true : false
+    end
+    
+    # Parses the given representation of date and time in the calendar, 
+    # and creates an date time instance.
+    # 
+    # @return [DateTime object]
+    def parse (timespec)
+      case @calendar
+      when :standard
+        time = DateTime.parse_timestamp(timespec, Date::ITALY, bc: @bc)
+      when :proleptic_gregorian
+        time = DateTime.parse_timestamp(timespec, Date::GREGORIAN, bc: @bc)
+      when :proleptic_julian
+        time = DateTime.parse_timestamp(timespec, Date::JULIAN, bc: @bc)
+      when :noleap
+        time = DateTime::NoLeap.parse_timestamp(timespec, bc: @bc)
+      when :allleap
+        time = DateTime::AllLeap.parse_timestamp(timespec, bc: @bc)
+      when SYM_360_day
+        time = DateTime::Fixed360Day.parse_timestamp(timespec, bc: @bc)
+      end
+      return time
+    end
+    
+    def jday2date (jday)
+      case @calendar
+      when :standard
+        time = DateTime.jd(jday, 0, 0, 0, 0, Date::ITALY)
+      when :proleptic_gregorian
+        time = DateTime.jd(jday, 0, 0, 0, 0, Date::GREGORIAN)
+      when :proleptic_julian
+        time = DateTime.jd(jday, 0, 0, 0, 0, Date::JULIAN)
+      when :noleap
+        time = DateTime::NoLeap.jd(jday, 0, 0, 0, 0)
+      when :allleap
+        time = DateTime::AllLeap.jd(jday, 0, 0, 0, 0)
+      when SYM_360_day
+        time = DateTime::Fixed360Day.jd(jday, 0, 0, 0, 0)
+      end
+      return time
+    end
+
+    def date2jday (year, month, day)
+      case @calendar
+      when :standard
+        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::ITALY)
+      when :proleptic_gregorian
+        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::GREGORIAN)
+      when :proleptic_julian
+        time = DateTime.new(year, month, day, 0, 0, 0, 0, Date::JULIAN)
+      when :noleap
+        time = DateTime::NoLeap.new(year, month, day, 0, 0, 0, 0)
+      when :allleap
+        time = DateTime::AllLeap.new(year, month, day, 0, 0, 0, 0)
+      when SYM_360_day
+        time = DateTime::Fixed360Day.new(year, month, day, 0, 0, 0, 0)
+      end
+      return time.jd
+    end
+    
+  end
+
+end