telescope

Telescopeは、Sun Grid Engine（SGE）オンデマンドスケジューリングシステムを使用してリモートサーバーに提出されたジョブの進行を追跡するオープンソースWeb Applciationです。これにより、事前に定義されたパイプラインのリモートスケジューリングと、キューに登録されたジョブを再スケジュールできます。さらに、出力ファイルはHTMLでリアルタイムでレンダリングされ、Markdownとリッチテキスト機能の使用が可能になります。 Telescopeは、SSH接続を除き、リモートサーバーから何も想定していません。接続は、暗号化後に保存されたSSHキーペアを使用して安定しています。

詳細、スクリーンショット、ライブデモについては、Wikiをご覧ください。

望遠鏡についてもっと知りたい場合、またはチームに参加して貢献したい場合は、私たちに連絡することをheしないでください。貢献する方法はいくつかあります！また、Wikiのドキュメント部分にアクセスして、ソフトウェアの詳細と、望遠鏡のインストールと実行に関する詳細をご覧ください。

このプロジェクトは、UCLAの定量的および計算生物学研究所（QCBIO）内のユニットであるCollaboratoryからの取り組みとして始まり、冬のPython Hackathon中に開発されました。現在、QCBIOコミュニティや他のさまざまなラボの多くの人々によって開発中です。また、このシステムを説明する論文に取り組んでおり、生物学者がユーザーフレンドリーな方法で大規模な計算施設の力を活用できるように使用する方法を説明しています。

クイックスタート

望遠鏡を始めるために必要な手順はほとんどありません。ステップバイステップのチュートリアルについては、こちらまたはこちらをクリックしてください。

インストール

望遠鏡を設置する最も簡単な方法は、 pipを使用することです。

 pip install git+https://github.com/QCB-Collaboratory/telescope

ランニング

インストールしたら、望遠鏡を実行するには2つのファイルが必要になります。（i）ユーザーの資格情報とサーバーアドレスを定義する構成ファイル、および（ii）サーバーを起動する小さなPythonスクリプト。

1. 次のコンテンツを含むconfig.iniという新しいファイルを作成します。

 [CREDENTIALS]
USER   = <USERNAME>
SERVER = <SERVER ADDRESS>

[CONFIGURATION]
DATABASE= <DATABASE NAME>

[MONITOR]
NUMUSERS = 1
USER1 = <USERNAME>

SSHキーを使用してリモートサーバーに接続する場合、パスワードフィールドは必要ありません（強くお勧めします）。 wikiで説明されているようにパスをカスタマイズしたい場合を除き、このconfig.ini現在のディレクトリに保管してください。

2. 次に、次のコンテンツを使用してRunTelescope.pyという別のファイルを作成します（注：テスコープリポジトリのテストディレクトリにコピーがあります）：

 import telescope

server = telescope . server ()
server . run ()

最後に、このPythonスクリプトを実行します。

 python RunTelescope.py

これにより、望遠鏡が実行されているWeb Broswerを自動的に開く必要があります。 RunTelescope.pyの詳細については、Wikiのドキュメント部分をご覧ください。

エラーメッセージが表示された場合は、バグが見つかった可能性があります。報告できれば感謝しています。詳細については、Wikiにアクセスするか、Gitterで会話に参加してください。

連絡、バグ、提案

バグを見つけたり、望遠鏡の提案をしている場合は、お願いします

• 詳細な説明で問題を開きます。
• ギターを使って私たちと話してください。

依存関係

望遠鏡は自己ホストされ、ユーザーのリストからジョブを追跡できます。 Python 2.7*または3*で実行され、次の非標準依存関係があります。

• パラミコ
• pynacl
• 竜巻
• numpy
• configparser

これらの依存関係は、 pipを使用して望遠鏡がインストールされている場合、自動的にインストールされます。

ライセンス

TelescopeはGNU General Public License v3.0で共有されています。少し時間を取って読んでください。このコピーレフトライセンスの許可は、同じライセンスの下で、ライセンスされた作業を使用した大規模な作品を含む、ライセンスされた作業と修正の完全なソースコードを利用可能にすることを条件としています。著作権とライセンス通知を保存する必要があります。貢献者は、特許権の明示的な助成金を提供します。

 Telescope
Copyright (C) 2017  QCB Collaboratory, et al

This material is a free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.