telescope

Telescope ist eine Open-Source-Webanmeldung, die den Fortschritt von Jobs verfolgt, die an Remote-Servern mithilfe von Sun Grid Engine (SGE) On-Demand-Planungssystem eingereicht wurden. Es ermöglicht die Fernplanung vordefinierter Pipelines sowie die Wiederherstellung von Jobs in der Warteschlange. Darüber hinaus werden in Echtzeit in HTML Ausgabedateien in HTML gerendert, sodass die Verwendung von Markdown- und Rich-Text-Funktionen verwendet werden kann. Telescope nimmt außer für die SSH -Verbindung nichts vom Remote -Server aus. Die Verbindung wird unter Verwendung von SSH -Schlüsselpaaren, die nach verschlüsselt gespeichert sind, gestrichen.

Weitere Informationen, Screenshots und ein Live-Demo finden Sie in unserem Wiki.

Wenn Sie mehr über Teleskop erfahren möchten oder sich dem Team anschließen möchten, um einen Beitrag zu leisten, zögern Sie nicht, uns zu kontaktieren. Es gibt verschiedene Möglichkeiten, einen Beitrag zu leisten! Besuchen Sie außerdem den Dokumentationsteil unseres Wiki, um weitere Beschreibungen der Software und Details zur Installation und zum Ausführen von Teleskop zu erhalten.

Dieses Projekt begann als Anstrengung der Zusammenarbeit, einer Einheit des Instituts für quantitative und rechnerische Biologie (QCBIO) an der UCLA, und wurde während des Winter -Python -Hackathons entwickelt. Es wird derzeit von einer Reihe von Personen aus der QCBIO -Community und verschiedenen anderen Labors entwickelt. Wir arbeiten auch an einem Papier, das dieses System beschreibt und wie es verwendet werden kann, um Biologen zu helfen, die Leistung großer Recheneinrichtungen auf benutzerfreundliche Weise zu nutzen.

Schneller Start

Es sind nur sehr wenige Schritte erforderlich, um mit Teleskop zu beginnen. Für ein Schritt-für-Schritt-Tutorial klicken Sie hier oder hier.

Installation

Der einfachste Weg, Teleskop zu installieren, ist die Verwendung von pip :

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

Läuft

Nach der Installation benötigen Sie zwei Dateien zum Ausführen von Teleskop: (i) eine Konfigurationsdatei, die die Anmeldeinformationen und die Serveradresse Ihres Benutzers definiert, und (ii) ein kleines Python -Skript, das den Server startet.

1. Erstellen Sie eine neue Datei namens config.ini mit dem folgenden Inhalt:

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

[CONFIGURATION]
DATABASE= <DATABASE NAME>

[MONITOR]
NUMUSERS = 1
USER1 = <USERNAME>

Das Feld Kennwort ist nicht erforderlich, wenn Sie einen SSH -Schlüssel verwenden, um eine Verbindung zum Remote -Server herzustellen ( sehr empfohlen). Stellen Sie sicher, dass Sie diese config.ini in Ihrem aktuellen Verzeichnis behalten, es sei denn, Sie möchten den Pfad wie im Wiki beschrieben anpassen.

2. Erstellen Sie dann eine andere Datei namens RunTelescope.py mit dem folgenden Inhalt (Hinweis: Im Testverzeichnis des Teleskop -Repo befindet sich eine Kopie):

 import telescope

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

Schließlich führen Sie dieses Python -Skript aus:

 python RunTelescope.py

Dies sollte automatisch einen Web -Broswer mit einem Teleskop eröffnen. Weitere Details zu RunTelescope.py finden Sie im Dokumentationsteil des Wiki.

Wenn eine Fehlermeldung angezeigt wird, haben Sie möglicherweise einen Fehler gefunden - wir würden uns freuen, wenn Sie sie melden könnten. Weitere Informationen finden Sie in unserem Wiki oder besuchen Sie das Gespräch bei Gitter.

Kontakt, Fehler und Vorschläge

Wenn Sie Fehler finden und/oder Vorschläge für Teleskop haben, bitte

• Eröffnen Sie ein Problem mit einer detaillierten Beschreibung;
• Verwenden Sie Gitter, um mit uns zu sprechen.

Abhängigkeiten

Teleskop kann selbst gehostet und Jobs von einer Liste von Benutzern verfolgen. Es läuft in Python 2.7* oder 3* mit den folgenden nicht standardmäßigen Abhängigkeiten:

• Paramiko
• Pynacl
• Tornado
• Numpy
• configParser

Diese Abhängigkeiten werden automatisch installiert, wenn das Teleskop mit pip installiert wird.

Lizenz

Teleskop wird im Rahmen der GNU General Public Lizenz v3.0 geteilt. Nehmen Sie sich bitte einen Moment Zeit, um es zu lesen. Die Berechtigungen dieser CopyLeft -Lizenz sind darauf bedacht, den vollständigen Quellcode für lizenzierte Arbeiten und Änderungen, die größere Arbeiten unter Verwendung einer lizenzierten Arbeiten unter derselben Lizenz enthalten, zur Verfügung zu stellen. Urheberrechts- und Lizenzbenachrichtigungen müssen erhalten bleiben. Mitwirkende bieten eine ausdrückliche Gewährung von Patentrechten.

 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/>.