WWT 0.0.1 → 0.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. data/README.md +84 -0
  2. data/lib/WWT/version.rb +1 -1
  3. metadata +6 -5
data/README.md ADDED
@@ -0,0 +1,84 @@
1
+ WWT
2
+ ===========
3
+
4
+ This is the beginnings of a gem to control Microsoft's word wide telescope from Ruby. It currently focuses on the desktop client
5
+
6
+ Features
7
+ --------
8
+
9
+ Control of pointing of telescope.
10
+ Earthquake like notifications
11
+
12
+ Connecting to WWT
13
+ -----------------
14
+ Connecting to a WWT instance is as simple as `WWT.new`. This defaults to connecting to *http://0.0.0.0:5050*.
15
+ You can also pass in a url and port if needed with `WWT.new url, port `
16
+ Once connected you will get back an instance of `WWTClient` which allows you to pass commands off to WWT.
17
+
18
+ Selecting WWT mode
19
+ ------------------
20
+ You can select the current mode by `WWTClient.look_at thing` where thing can be "Earth", "Sky", "SolarSystem" etc
21
+
22
+ Incremental movements
23
+ --------------------
24
+
25
+ You can make the telescope move incrementally (the equivalent of pressing keys in the GUI interface) using `WWTClient.move motion` where motion can be ["Left", "Right", "Up", "Down", "Clockwise", "CounterClockwise",]
26
+
27
+ Layers
28
+ ------
29
+
30
+ We support the creation of layers within the WWT framework using `layer=WWTClient.new_layer :frame=>frame, :name=>name, :data=>['ra','dec','time']` where frame is the frame this layer is sent to and name is a name given to a layer and data tells us what type of data this layer is going to show. This returns an instance of WWT_layer which allows access to that layer. There are many other options that can be passed in through the hash for a full list look at http://www.worldwidetelescope.org/Docs/WorldWideTelescope_lcapi.html.
31
+
32
+ Updating
33
+ --------
34
+
35
+ We can push data to the layer for visulisation with `layer.update :data=>["10","10",'02/03/1999 10:20:33]`
36
+
37
+ Properties
38
+ ----------
39
+
40
+ Any property of a layer can be got by `later.property_with_underscores`, for example in the WWT documentation (http://www.worldwidetelescope.org/Docs/WorldWideTelescope_lcapi.html#Table_of_Properties) we have "EndTime" to get this we would call `layer.end_time` and to set it `layer.end_time=`
41
+
42
+ Requirements
43
+ ------------
44
+
45
+ You will need to have an install of WWT on your machine or another machine with port 5050 open. This is where WWT listens to. You also need to have the IP of controlling machine enabled in the list of approved sources in WWT.
46
+
47
+ Install
48
+ -------
49
+
50
+ gem install WWT
51
+
52
+ Author
53
+ ------
54
+
55
+ Original author: Stuart Lynn
56
+
57
+ Contributors:
58
+
59
+
60
+ License
61
+ -------
62
+
63
+ (The MIT License) FIXME (different license?)
64
+
65
+ Copyright (c) 2011 FIXME (author's name)
66
+
67
+ Permission is hereby granted, free of charge, to any person obtaining
68
+ a copy of this software and associated documentation files (the
69
+ 'Software'), to deal in the Software without restriction, including
70
+ without limitation the rights to use, copy, modify, merge, publish,
71
+ distribute, sublicense, and/or sell copies of the Software, and to
72
+ permit persons to whom the Software is furnished to do so, subject to
73
+ the following conditions:
74
+
75
+ The above copyright notice and this permission notice shall be
76
+ included in all copies or substantial portions of the Software.
77
+
78
+ THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
79
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
80
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
81
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
82
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
83
+ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
84
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/lib/WWT/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Wwt
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: WWT
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  prerelease:
6
6
  platform: ruby
7
7
  authors:
@@ -13,7 +13,7 @@ date: 2011-09-14 00:00:00.000000000Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: rest-client
16
- requirement: &70282162367840 !ruby/object:Gem::Requirement
16
+ requirement: &70242630577740 !ruby/object:Gem::Requirement
17
17
  none: false
18
18
  requirements:
19
19
  - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
21
21
  version: '0'
22
22
  type: :runtime
23
23
  prerelease: false
24
- version_requirements: *70282162367840
24
+ version_requirements: *70242630577740
25
25
  - !ruby/object:Gem::Dependency
26
26
  name: hpricot
27
- requirement: &70282162367420 !ruby/object:Gem::Requirement
27
+ requirement: &70242630577320 !ruby/object:Gem::Requirement
28
28
  none: false
29
29
  requirements:
30
30
  - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
32
32
  version: '0'
33
33
  type: :runtime
34
34
  prerelease: false
35
- version_requirements: *70282162367420
35
+ version_requirements: *70242630577320
36
36
  description: ! "This gem exposes the WWT remote API(or at least most of it) to ruby.
37
37
  It works by sending given commands to an open port on the \n machine running
38
38
  WWT."
@@ -44,6 +44,7 @@ extra_rdoc_files: []
44
44
  files:
45
45
  - .gitignore
46
46
  - Gemfile
47
+ - README.md
47
48
  - Rakefile
48
49
  - WWT.gemspec
49
50
  - lib/WWT.rb