celes 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in celes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,32 @@
+Copyright (C) 2013, Naoki Arita
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1 Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+2 Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in
+  the documentation and/or other materials provided with the
+  distribution.
+
+3 Neither the name of the Standards Of Fundamental Astronomy Board,
+  the International Astronomical Union nor the names of its
+  contributors may be used to endorse or promote products derived
+  from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,179 @@
+# Celes
+
+Celes is a wrapper of the SOFA Library for Ruby.
+
+The SOFA Library has many functions for astronomical computing. The original library is available in Fortran 77 and ANSI C. Please see for more information about the SOFA Library: http://www.iausofa.org/.
+
+Celes is a derived work of the SOFA Library and includes original files in accordance with [the SOFA Software License](http://www.iausofa.org/tandc.html).
+
+## Dependencies
+
+Ruby 1.8.7 or later
+
+## Licenses
+
+The 3-clause BSD License, the names of organizations of Article 3 have the IAU and the SOFA.
+
+## Installation
+
+### from RubyGems
+
+```sh
+$ sudo gem install celes
+```
+
+### from source
+
+```sh
+$ # download Celes
+$ git clone https://github.com/tohka/celes.git
+$ cd celes
+$ 
+$ # build gem
+$ rake build
+$ 
+$ # install with built gem file
+$ sudo gem install pkg/celes-0.0.1.gem
+```
+
+### from source without gem file
+
+```sh
+$ # download Celes
+$ git clone https://github.com/tohka/celes.git
+$ cd celes
+$ 
+$ cd ext/celes
+$ 
+$ # create Makefile and do make
+$ ruby ./extconf.rb
+$ make
+$ 
+$ ls *.so
+celes_core.so
+```
+
+## Usage
+
+```ruby
+require 'celes'
+
+# UTC to TAI
+p Celes::utctai(2400000.5, 45678.9)
+#=> [2400000.5, 45678.90025462963]
+```
+
+## Documentation
+
+Celes's documentation is unprepared, but Celes is based on the original SOFA Library.
+
+For example, to convert Gregorian Calendar date into Julian Date.
+
+```c
+// in C, using the SOFA Library
+#include <stdio.h>
+#include "sofa.h"
+#include "sofam.h"
+
+int status;
+double djm0, djm;
+
+status = iauCal2jd(2000, 12, 23, &djm0, &djm);
+
+if(status){
+  printf("error or warning\n");
+} else{
+  printf("Julian Day is %f\n", djm0 + djm);
+}
+//=> Julian Day is 2451901.5
+```
+
+```ruby
+# in Ruby, using Celes
+require 'celes'
+
+begin
+  djm0, djm = Celes::cal2jd(2000, 12, 23)
+rescue
+  puts "error"
+else
+  if Celes::status.nonzero?
+    puts "warning"
+  else
+    puts "Julian Day is #{djm0 + djm}"
+  end
+end
+#=> Julian Day is 2451901.5
+```
+
+### Rules
+
+* basically, according to the original SOFA Library
+* functions' name are lower-case
+* a prefix <var>iau</var> or <var>iau_</var> is removed
+* some functions are bang functions, their arguments value are replaced and name are with '!'
+  * <var>zp!</var>, <var>zr!</var>, <var>ir!</var>, <var>zpv!</var>, <var>rx!</var>, <var>ry!</var> and <var>rz!</var>
+  * Celes has also non-bang functions, <var>zp</var>, <var>zr</var>, ...
+* arguments for output are removed
+* when they have multi returned values, return as array object
+* functions do not return status code
+* <var>Celes::status</var> returns a last status code
+* raise exception if status code implies error
+
+### Bang and non-bang functions
+
+Methods for clearing a vector or a matrix, <var>zp!</var>, <var>zr!</var>, <var>ir!</var> and <var>zpv!</var>.
+
+```ruby
+# in Ruby
+
+# vector
+p1 = [1.0, 2.0, 3.0]
+
+Celes::zp!(p1)
+p p1 #=> [0.0, 0.0, 0.0]
+
+# non-bang version, has no arguments
+p2 = Celes::zp
+p p2 #=> [0.0, 0.0, 0.0]
+```
+
+----
+
+Methods for rotating a matrix about an axis, <var>rx!</var>, <var>ry!</var> and <var>rz!</var>.
+
+```ruby
+# in Ruby
+format = "[%9.6f, %9.6f, %9.6f]"
+
+# matrix
+r1 = Celes::ir
+puts format % r1[0] #=> [ 1.000000,  0.000000,  0.000000]
+puts format % r1[1] #=> [ 0.000000,  1.000000,  0.000000]
+puts format % r1[2] #=> [ 0.000000,  0.000000,  1.000000]
+
+# rotate about z-axis
+Celes::rz!(Math::PI/3.0, r1)
+puts format % r1[0] #=> [ 0.500000,  0.866025,  0.000000]
+puts format % r1[1] #=> [-0.866025,  0.500000,  0.000000]
+puts format % r1[2] #=> [ 0.000000,  0.000000,  1.000000]
+
+# non-bang version
+r2 = Celes::rz(Math::PI/3.0, r1)
+puts format % r1[0] #=> [ 0.500000,  0.866025,  0.000000]
+puts format % r1[1] #=> [-0.866025,  0.500000,  0.000000]
+puts format % r1[2] #=> [ 0.000000,  0.000000,  1.000000]
+
+puts format % r2[0] #=> [-0.500000,  0.866025,  0.000000]
+puts format % r2[1] #=> [-0.866025, -0.500000,  0.000000]
+puts format % r2[2] #=> [ 0.000000,  0.000000,  1.000000]
+```
+
+### Original documentation
+
+A documentation about the SOFA Library.
+
+* http://www.iausofa.org/current_F.html#Documents (Fortran 77)
+* http://www.iausofa.org/current_C.html#Documents (ANSI C)
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/celes.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'celes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "celes"
+  gem.version       = Celes::VERSION
+  gem.authors       = ["Naoki Arita"]
+  gem.email         = ["ToNaokiArita@gmail.com"]
+  gem.description   = %q{A library for astronomical computing.}
+  gem.summary       = %q{A wrapper of the SOFA Library for Ruby.}
+  gem.license       = "3-clause BSD"
+  gem.homepage      = "https://github.com/tohka/celes"
+  gem.extensions   << "ext/celes/extconf.rb"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["ext", "lib"]
+  gem.required_ruby_version = ">= 1.8.7"
+end

data/ext/celes/a2af.c

@@ -0,0 +1,120 @@
+#include "sofam.h"
+
+void iauA2af(int ndp, double angle, char *sign, int idmsf[4])
+/*
+**  - - - - - - - -
+**   i a u A 2 a f
+**  - - - - - - - -
+**
+**  Decompose radians into degrees, arcminutes, arcseconds, fraction.
+**
+**  Status:  vector/matrix support function.
+**
+**  Given:
+**     ndp     int     resolution (Note 1)
+**     angle   double  angle in radians
+**
+**  Returned:
+**     sign    char    '+' or '-'
+**     idmsf   int[4]  degrees, arcminutes, arcseconds, fraction
+**
+**  Called:
+**     iauD2tf      decompose days to hms
+**
+**  Notes:
+**
+**  1) The argument ndp is interpreted as follows:
+**
+**     ndp         resolution
+**      :      ...0000 00 00
+**     -7         1000 00 00
+**     -6          100 00 00
+**     -5           10 00 00
+**     -4            1 00 00
+**     -3            0 10 00
+**     -2            0 01 00
+**     -1            0 00 10
+**      0            0 00 01
+**      1            0 00 00.1
+**      2            0 00 00.01
+**      3            0 00 00.001
+**      :            0 00 00.000...
+**
+**  2) The largest positive useful value for ndp is determined by the
+**     size of angle, the format of doubles on the target platform, and
+**     the risk of overflowing idmsf[3].  On a typical platform, for
+**     angle up to 2pi, the available floating-point precision might
+**     correspond to ndp=12.  However, the practical limit is typically
+**     ndp=9, set by the capacity of a 32-bit int, or ndp=4 if int is
+**     only 16 bits.
+**
+**  3) The absolute value of angle may exceed 2pi.  In cases where it
+**     does not, it is up to the caller to test for and handle the
+**     case where angle is very nearly 2pi and rounds up to 360 degrees,
+**     by testing for idmsf[0]=360 and setting idmsf[0-3] to zero.
+**
+**  This revision:  2008 May 27
+**
+**  Original version 2012-03-01
+**
+**  Copyright (C) 2013 Naoki Arita.  See notes at end.
+*/
+{
+/* Hours to degrees * radians to turns */
+   const double F = 15.0 / D2PI;
+
+
+/* Scale then use days to h,m,s function. */
+   iauD2tf(ndp, angle*F, sign, idmsf);
+
+   return;
+
+/*----------------------------------------------------------------------
+**
+**  Celes is a wrapper of the SOFA Library for Ruby.
+**
+**  This file is redistributed and relicensed in accordance with 
+**  the SOFA Software License (http://www.iausofa.org/tandc.html).
+**
+**  The original library is available from IAU Standards of
+**  Fundamental Astronomy (http://www.iausofa.org/).
+**
+**
+**
+**
+**
+**  Copyright (C) 2013, Naoki Arita
+**  All rights reserved.
+**
+**  Redistribution and use in source and binary forms, with or without
+**  modification, are permitted provided that the following conditions
+**  are met:
+**
+**  1 Redistributions of source code must retain the above copyright
+**    notice, this list of conditions and the following disclaimer.
+**
+**  2 Redistributions in binary form must reproduce the above copyright
+**    notice, this list of conditions and the following disclaimer in
+**    the documentation and/or other materials provided with the
+**    distribution.
+**
+**  3 Neither the name of the Standards Of Fundamental Astronomy Board,
+**    the International Astronomical Union nor the names of its
+**    contributors may be used to endorse or promote products derived
+**    from this software without specific prior written permission.
+**
+**  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+**  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+**  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+**  FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+**  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+**  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+**  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+**  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+**  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+**  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+**  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+**  POSSIBILITY OF SUCH DAMAGE.
+**
+**--------------------------------------------------------------------*/
+}

data/ext/celes/a2tf.c

@@ -0,0 +1,116 @@
+#include "sofam.h"
+
+void iauA2tf(int ndp, double angle, char *sign, int ihmsf[4])
+/*
+**  - - - - - - - -
+**   i a u A 2 t f
+**  - - - - - - - -
+**
+**  Decompose radians into hours, minutes, seconds, fraction.
+**
+**  Status:  vector/matrix support function.
+**
+**  Given:
+**     ndp     int     resolution (Note 1)
+**     angle   double  angle in radians
+**
+**  Returned:
+**     sign    char    '+' or '-'
+**     ihmsf   int[4]  hours, minutes, seconds, fraction
+**
+**  Called:
+**     iauD2tf      decompose days to hms
+**
+**  Notes:
+**
+**  1) The argument ndp is interpreted as follows:
+**
+**     ndp         resolution
+**      :      ...0000 00 00
+**     -7         1000 00 00
+**     -6          100 00 00
+**     -5           10 00 00
+**     -4            1 00 00
+**     -3            0 10 00
+**     -2            0 01 00
+**     -1            0 00 10
+**      0            0 00 01
+**      1            0 00 00.1
+**      2            0 00 00.01
+**      3            0 00 00.001
+**      :            0 00 00.000...
+**
+**  2) The largest positive useful value for ndp is determined by the
+**     size of angle, the format of doubles on the target platform, and
+**     the risk of overflowing ihmsf[3].  On a typical platform, for
+**     angle up to 2pi, the available floating-point precision might
+**     correspond to ndp=12.  However, the practical limit is typically
+**     ndp=9, set by the capacity of a 32-bit int, or ndp=4 if int is
+**     only 16 bits.
+**
+**  3) The absolute value of angle may exceed 2pi.  In cases where it
+**     does not, it is up to the caller to test for and handle the
+**     case where angle is very nearly 2pi and rounds up to 24 hours,
+**     by testing for ihmsf[0]=24 and setting ihmsf(0-3) to zero.
+**
+**  This revision:  2008 May 11
+**
+**  Original version 2012-03-01
+**
+**  Copyright (C) 2013 Naoki Arita.  See notes at end.
+*/
+{
+/* Scale then use days to h,m,s function. */
+   iauD2tf(ndp, angle/D2PI, sign, ihmsf);
+
+   return;
+
+/*----------------------------------------------------------------------
+**
+**  Celes is a wrapper of the SOFA Library for Ruby.
+**
+**  This file is redistributed and relicensed in accordance with 
+**  the SOFA Software License (http://www.iausofa.org/tandc.html).
+**
+**  The original library is available from IAU Standards of
+**  Fundamental Astronomy (http://www.iausofa.org/).
+**
+**
+**
+**
+**
+**  Copyright (C) 2013, Naoki Arita
+**  All rights reserved.
+**
+**  Redistribution and use in source and binary forms, with or without
+**  modification, are permitted provided that the following conditions
+**  are met:
+**
+**  1 Redistributions of source code must retain the above copyright
+**    notice, this list of conditions and the following disclaimer.
+**
+**  2 Redistributions in binary form must reproduce the above copyright
+**    notice, this list of conditions and the following disclaimer in
+**    the documentation and/or other materials provided with the
+**    distribution.
+**
+**  3 Neither the name of the Standards Of Fundamental Astronomy Board,
+**    the International Astronomical Union nor the names of its
+**    contributors may be used to endorse or promote products derived
+**    from this software without specific prior written permission.
+**
+**  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+**  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+**  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+**  FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
+**  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+**  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+**  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+**  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+**  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+**  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+**  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+**  POSSIBILITY OF SUCH DAMAGE.
+**
+**--------------------------------------------------------------------*/
+}