Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

OMERO Downloader

O repositório de imagens OMERO é uma plataforma para armazenamento, gerenciamento e compartilhamento de imagens científicas, especialmente de microscopia.

O OMERO Downloader é uma ferramenta de linha de comando que serve para baixar em massa imagens e metadados de um repositório OMERO, preservando a estrutura de pastas dos datasets e projetos. Essa ferramenta é útil para obter cópias locais das imagens armazenadas no repositório.

Para mais informações sobre o OMERO Downloader, acesse https://github.com/ome/omero-downloader.

Carregando o modulo

Para habilitar o OMERO Downloader no HPCC Marvin, você deve carregar o módulo omero-downloader:

module load omero-downloader

As versões disponíveis do OMERO Downloader no HPCC Marvin são:
  • omero-downloader/0.2.2 (D)
Onde (D) indica a versão padrão.

Para acessar a documentação do módulo, use:

module help omero-downloader

Para acessar a documentação completa dos parâmetros do OMERO Downloader, execute:

omero-downloader --help

Realizando login

O OMERO Downloader requer autenticação para acessar os dados armazenados no repositório. No entanto, ao informar usuário e senha diretamente no comando, essas informações podem ficar visíveis na listagem de processos do sistema. Para evitar esse cenário, recomenda-se realizar a autenticação previamente com o comando omero login e, em seguida, executar o OMERO Downloader utilizando uma chave de sessão por meio da opção -k.

Para isso, carregue o módulo do OMERO CLI:

ml load omero

Em seguida, execute o comando de login:

omero login -s omero-lnbio.cnpem.br -u <user_name>

Você será solicitado a inserir senha. Após o login, uma chave de sessão será gerada e armazenada localmente. Para usar essa chave de sessão com o OMERO Downloader.

Para verificar as suas chaves de sessão, use:

omero sessions list

Você verá algo como isso:

$ omero sessions list
 Server               | User     | Group | Session                              | Active    | Started
----------------------+----------+-------+--------------------------------------+-----------+--------------------------
 omero-lnbio.cnpem.br | analista | LIB   | b22d1f3c-e7f3-4cb4-afea-4ce656d82dab | Logged in | Mon Mar  2 15:29:09 2026
(1 row)

No exemplo acima, você utilizaria a chave de sessão b22d1f3c-e7f3-4cb4-afea-4ce656d82dab com a opção -k do OMERO Downloader.

Baixando dados

O comando base para baixar dados com o OMERO Downloader é o seguinte:

omero-downloader -b <output_dir> -k <session_key> -f <file> <type>:<ID>

Substitua as informações indicadas entre colchetes angulares (<...>):
  • <output_dir>: diretório onde os dados serão baixados. É importante que a pasta já exista.
  • <user_name>: seu nome de usuário institucional, no formato nome.sobrenome.
  • <password>: sua senha institucional.
  • <file>: formato do arquivo a ser baixado. O formato recomendado é ome-tiff; outros formatos estão disponíveis na documentação de parâmetros do OMERO Downloader.
  • <type>: tipo de objeto que você deseja baixar:
    • Image: imagem individual
    • Plate: placa de experimentos multi-poços
    • Screen: conjunto de placas
    • Dataset: conjunto de arquivos de imagem
    • Project: conjunto de datasets
  • <ID>:identificador numérico do objeto no OMERO..

Para baixar uma imagem, use:

omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Image:123

Para baixar um Dataset, use:

omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Dataset:123

Para baixar um projeto, use:

omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Project:123

Para descobrir o número de identificação (ID) de uma imagem, dataset ou projeto, acesse a plataforma https://omero-lnbio.cnpem.br. Nela, é possível visualizar a organização dos projetos, datasets e imagens aos quais você tem acesso. Ao selecionar o item desejado, o ID correspondente será exibido no painel à direita, na guia “General”.