telescope

O Telescope é um aplicativo da Web de código aberto que rastreia o progresso dos trabalhos enviados para servidores remotos usando o sistema de agendamento sob demanda do mecanismo de grade Sun (SGE). Ele permite a programação remota de pipelines predefinidos, bem como empregos em fila de remarcação. Além disso, os arquivos de saída são renderizados em HTML em tempo real, permitindo o uso de recursos de marcação e texto rico. O Telescope não assume nada do servidor remoto, exceto a conexão SSH. A conexão está estabilizada usando pares de teclas SSH que são armazenados após criptografados.

Para mais informações, capturas de tela e um democonato ao vivo, visite nosso wiki.

Se você estiver interessado em aprender mais sobre o telescópio ou se deseja ingressar na equipe para contribuir, não hesite em entrar em contato conosco. Existem várias maneiras de contribuir! Além disso, visite a parte da documentação do nosso wiki para obter mais descrições do software e detalhes sobre a instalação e a execução do Telescope.

Este projeto começou como um esforço do colaboratório, uma unidade do Instituto de Biologia Quantitativa e Computacional (QCBIO) na UCLA e foi desenvolvida durante o Hackathon de Winter Python. Atualmente, está em desenvolvimento por várias pessoas da comunidade QCBIO e de vários outros laboratórios. Também estamos trabalhando em um artigo que descreve este sistema e como ele pode ser usado para ajudar os biólogos a aproveitar o poder de grandes instalações computacionais de maneira amigável.

Início rápido

Existem muito poucas etapas necessárias para começar o telescópio. Para um tutorial passo a passo, clique aqui ou aqui.

Instalação

A maneira mais fácil de instalar o Telescope é usando pip :

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

Correndo

Depois de instalado, você precisará de dois arquivos para executar o Telescope: (i) um arquivo de configuração que define as credenciais e o endereço do servidor do usuário e (ii) um pequeno script Python que inicia o servidor.

1. Crie um novo arquivo chamado config.ini com o seguinte conteúdo:

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

[CONFIGURATION]
DATABASE= <DATABASE NAME>

[MONITOR]
NUMUSERS = 1
USER1 = <USERNAME>

O campo de senha não é necessário se você usar uma tecla SSH para conectar -se ao servidor remoto ( altamente recomendado). Certifique -se de manter este config.ini em seu diretório atual, a menos que você queira personalizar o caminho, conforme descrito no wiki.

2. Em seguida, crie outro arquivo chamado RunTelescope.py com o seguinte conteúdo (Nota: Há uma cópia no diretório de teste do repo telescópio):

 import telescope

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

Finalmente, execute este script Python:

 python RunTelescope.py

Isso deve abrir automaticamente uma Web Broswer com o telescópio em execução. Mais detalhes sobre RunTelescope.py podem ser encontrados na parte de documentação do wiki.

Se uma mensagem de erro aparecer, você pode ter encontrado um bug - gostaríamos de relatá -lo. Para mais detalhes, visite nosso wiki ou participe da conversa no Gitter.

Contato, bugs e sugestões

Se você encontrar bugs e/ou ter sugestões para o telescópio, por favor

• Abra um problema com uma descrição detalhada;
• Use Gitter para falar conosco.

Dependências

O telescópio pode ser auto-hospedado e rastrear trabalhos de uma lista de usuários. Ele é executado no Python 2.7* ou 3*, com as seguintes dependências não padrão:

• Paramiko
• Pynacl
• tornado
• Numpy
• Configparser

Essas dependências serão instaladas automaticamente se o Telescope for instalado usando pip .

Licença

O Telescope é compartilhado sob a licença pública geral da GNU v3.0, por favor, reserve um momento para lê -lo. As permissões desta licença copyleft estão condicionadas a disponibilizar o código fonte completo de obras e modificações licenciadas, que incluem trabalhos maiores usando um trabalho licenciado, sob a mesma licença. Os avisos de direitos autorais e licenças devem ser preservados. Os colaboradores fornecem uma concessão expressa de direitos de patente.

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