qm 0.9.14 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -43
  3. data/lib/qm.rb +13 -4
  4. metadata +2 -3
  5. data/lib/katamari.rb +0 -17
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 59931e83b540358bf1c4412688494c746bd78174
4
- data.tar.gz: 514402f8bc17e3e131c8a094706747f60d2d8316
3
+ metadata.gz: 494c547630247eebed08e5b5a1feb33c14060d17
4
+ data.tar.gz: a8a22fd2cffca661444bd063bbad455a378d7e23
5
5
  SHA512:
6
- metadata.gz: cfa6a804fbec8d86d8e64d007096e7a1715cbd943c180348ffec0c91739d53f30f1c1d8017aa3def05dc119539bd49531ff97dcce2c9527eec448d1f6a623f24
7
- data.tar.gz: 17de4a2ee91af73c8eae9d9ad75c33e13544642ae0a0db83815fd8568027b2d9db92bc6606da62d14411b8cfe0a17d62c0b96705b505b9035e2ff13199bb6b04
6
+ metadata.gz: c16a034737eff9f3568dc72beb673cebc7de94d16cb76a500582a63b73ce68972d52cc3311858e0d07b1b3c67bbd644c526d40cf867be7e6b24d62232d10d37a
7
+ data.tar.gz: e6ea55d623ca8a260de5036f22bde62af1561d7d8ee817668e7a6e282723e22830160618c9bd7a936c58486073d6bbd63ae4ffa15a091fbd25d848cb296b0913
data/README.md CHANGED
@@ -1,54 +1,31 @@
1
1
  QMachine
2
2
  ========
3
3
 
4
- [QMachine](https://www.qmachine.org) (QM) is a web service that uses
4
+ [QMachine (QM)](https://www.qmachine.org) is a web service that uses
5
5
  [Quanah](http://wilkinson.github.io/quanah) to create a distributed computer
6
- that can use ordinary web browsers as ephemeral nodes. It contains three main
7
- components: an API server, a web server, and a website. The API server and the
8
- web server are both implemented in [Node.js](http://nodejs.org) and available
9
- for use in server environments via [NPM](https://npmjs.org/package/qm). The API
10
- server supports [CORS](http://www.w3.org/TR/cors/) and configurable persistent
11
- storage for a variety of popular databases, including
12
- [Apache CouchDB](http://couchdb.apache.org/),
13
- [MongoDB](http://www.mongodb.org/), [PostgreSQL](http://www.postgresql.org),
14
- [Redis](http://redis.io), and [SQLite](http://www.sqlite.org). The web server
15
- exists only to serve the website. The website functions as an example browser
16
- client for the QM API, and its implementation as static content written in
17
- [HTML5](http://www.whatwg.org/specs/web-apps/current-work/multipage/),
18
- [CSS](http://www.w3.org/Style/CSS/Overview.en.html), and
19
- [JavaScript](http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-262.pdf) allows it to be served out of memory by the web server for high
20
- performance and used by ordinary web browsers for high portability. Parts of
21
- the browser client are installable via Twitter's
22
- [Bower](http://twitter.github.io/bower/) package manager, but I have only
23
- recently experimented with that. The analytical layer can also be used from
24
- [MinervaJS](http://minervajs.org/site/index.html#!/view/qm) and the
25
- [TCGA Toolbox](http://tcga.github.io/).
6
+ powered by web browsers. QM contains three main components: an API server, a
7
+ web server, and a website. The API server provides a message-passing interface
8
+ between nodes using HTTP and JSON, and the web server exists only to serve the
9
+ website, which functions as the browser client application.
26
10
 
27
- There are several project "mirrors" available on
28
- [Bitbucket](https://bitbucket.org/wilkinson/qmachine),
29
- [GitHub](https://github.com/wilkinson/qmachine), and
30
- [Google Code](https://qmachine.googlecode.com). Various project statistics are
31
- available on [GitHub](https://github.com/wilkinson/qmachine/graphs) and
32
- [Ohloh](https://www.ohloh.net/p/qm), too.
11
+ Currently, there are two implementations of the server-side components. The
12
+ original version is written in [Node.js](http://nodejs.org) and is available
13
+ for deployment to server environments via [NPM](https://npmjs.org/package/qm).
14
+ A new "teaching version" written in [Ruby](http://www.ruby-lang.org) is also
15
+ available, and it will eventually be installable via
16
+ [Gem](https://rubygems.org/gems/qm).
33
17
 
34
- I have done some preliminary investigation into app integration for
35
-
36
- - [Google Chrome](https://chrome.google.com/webstore/detail/meagomakeegjimdibmlodmilfhplkjgp)
37
- - [Facebook](http://apps.facebook.com/qmachine/)
38
- - [Firefox Marketplace](https://marketplace.firefox.com/app/qmachine/)
39
- - [Twitter](https://dev.twitter.com/apps/1755018/)
40
-
41
- I have now submitted the first of several manuscripts I have been preparing for
18
+ I am now revising the first of several manuscripts I have been preparing for
42
19
  peer-reviewed academic journals. These reports will explain some of the design
43
20
  decisions behind QM, demonstrate the use of QM in scientific workflows, and
44
- elaborate on the future directions of QM. My labmates have finally convinced me
45
- that my "documentation as comments in the source code" approach is inadequate,
46
- and thus I have begun a [wiki](https://wiki.qmachine.org). I have also recently
47
- published a few screencasts on
48
- [YouTube](http://www.youtube.com/playlist?list=PLijUCyE0Z0-8nLL5qJ__v-VB3ZoRxSubg),
49
- one of which has been featured on the
50
- [insideHPC](http://insidehpc.com/2013/03/09/video-qmachine-commodity-supercomputing-with-web-browsers/)
51
- and
21
+ elaborate on the future directions of QM. I published a few screencasts on
22
+ [YouTube](http://www.youtube.com/playlist?list=PLijUCyE0Z0-8nLL5qJ__v-VB3ZoRxSubg)
23
+ recently, one of which has been featured on the
52
24
  [HPCwire](http://www.hpcwire.com/hpcwire/2013-03-14/qmachine_combines_hpc_with_www.html)
25
+ and
26
+ [insideHPC](http://insidehpc.com/2013/03/09/video-qmachine-commodity-supercomputing-with-web-browsers/)
53
27
  news sites.
54
28
 
29
+ For more information, see
30
+ [https://wiki.qmachine.org](https://wiki.qmachine.org) :-)
31
+
data/lib/qm.rb CHANGED
@@ -6,6 +6,19 @@
6
6
 
7
7
  module QM
8
8
 
9
+ private
10
+
11
+ class QM_Client
12
+
13
+ def initialize
14
+ # This function needs documentation.
15
+ # ...
16
+ end
17
+
18
+ end
19
+
20
+ public
21
+
9
22
  def self::launch_client()
10
23
  # This function needs documentation.
11
24
  puts '(placeholder: `launch_client`)';
@@ -18,10 +31,6 @@ module QM
18
31
  return;
19
32
  end
20
33
 
21
- require './lib/katamari';
22
-
23
- self::KATAMARI = KATAMARI;
24
-
25
34
  end
26
35
 
27
36
  #- vim:set syntax=ruby:
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: qm
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.14
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sean Wilkinson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2013-05-15 00:00:00.000000000 Z
11
+ date: 2013-05-30 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: This is a *very incomplete* port of QMachine.
14
14
  email: sean@mathbiol.org
@@ -18,7 +18,6 @@ extra_rdoc_files:
18
18
  - README.md
19
19
  files:
20
20
  - lib/qm.rb
21
- - lib/katamari.rb
22
21
  - README.md
23
22
  homepage: https://www.qmachine.org
24
23
  licenses: []
data/lib/katamari.rb DELETED
@@ -1,17 +0,0 @@
1
- #- Ruby source code
2
-
3
- #- katamari.rb ~~
4
- # ~~ (c) SRW, 16 Apr 2013
5
- # ~~ last updated 17 Apr 2013
6
-
7
- module KATAMARI
8
-
9
- def self::roll_up(public_html, json_file)
10
- # This function needs documentation.
11
- puts '(placeholder: `roll_up`)';
12
- return;
13
- end
14
-
15
- end
16
-
17
- #- vim:set syntax=ruby: