Skip to content

Commit ea4ecb3

Browse files
r1ckhdkjvsguerra
r1ckhdk
and
jvsguerra
authored
Update OMERO Downloader documentation (#24)
* Update OMERO Downloader version and documentation * Update authentication instructions for OMERO Downloader * Add OMERO-CLI documentation --------- Co-authored-by: João Victor Guerra <jvsguerra@gmail.com>
1 parent 4cea9f7 commit ea4ecb3

File tree

5 files changed

+113
-11
lines changed

5 files changed

+113
-11
lines changed

‎book.toml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
[book]
2-
title = "MarvinDocs v1.2.4"
2+
title = "MarvinDocs v1.2.5"
33
authors = [
44
"José G. C. Pereira",
55
"João V. S. Guerra",
66
"João V. R. Santos",
77
"Luiz F. G. Alves",
88
"Pablo W. A. Silva",
99
"Rick H. Hokama",
10-
"Samuel C. de Assis"
10+
"Samuel C. de Assis",
11+
"Gabriel F. Totene"
1112
]
1213
description = "Documentação do HPCC Marvin"
1314
src = "src"

‎src/07-programas-e-aplicativos/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Os programas e aplicativos relacionados à processamento e análise de imagens b
4343
- [CellProfiler](./cellprofiler/index.html)
4444
- [Fiji](./fiji/index.html)
4545
- [Ilastik](./ilastik/index.html)
46+
- [OMERO-CLI](./omero-cli/index.html)
4647
- [OMERO Downloader](./omero-downloader/index.html)
4748

4849
<h2>Biologia Estrutural</h2>

‎src/07-programas-e-aplicativos/omero-cli/README.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# OMERO CLI
2+
3+
O OMERO-CLI é um conjunto de ferramentas de linha de comando baseado em Python, feito para interagir com servidores OMERO. Ele permite que os usuários realizem várias operações, como autenticação, upload/download, import/export, gerenciamento de dados e muito mais, diretamente do terminal.
4+
5+
Para mais informações, acesse a documentação oficial do OMERO-CLI em <https://omero.readthedocs.io/en/stable/users/cli/overview.html>.
6+
7+
## Carregando o módulo
8+
9+
Para habilitar o OMERO-CLI no HPCC Marvin, você deve carregar o módulo `omero`:
10+
11+
```bash
12+
module load omero
13+
```
14+
15+
<div class="warning">
16+
<br>As versões disponíveis do OMERO-CLI no HPCC Marvin são:
17+
<ul>
18+
<li><code>omero/5.22 (D)</code></li>
19+
</ul>
20+
Onde <code>(D)</code> indica a versão padrão.<br>
21+
</div>
22+
23+
Para acessar a documentação do módulo, use:
24+
25+
```bash
26+
module help omero
27+
```
28+
29+
Para acessar a documentação completa dos parâmetros do OMERO Downloader, execute:
30+
31+
```bash
32+
omero --help
33+
```
34+
35+
## Realizando login
36+
37+
O OMERO-CLI requer autenticação para acessar os dados armazenados no repositório. Para realizar o login, use o comando `omero login`:
38+
39+
```bash
40+
omero login
41+
```
42+
43+
Dados como servidor, usuário e senha serão solicitados interativamente. Você também pode passar todos eles como argumentos para evitar a solicitação interativa:
44+
45+
```bash
46+
omero login -s omero-lnbio.cnpem.br -u <user_name> -w <senha>
47+
```
48+
49+
## Autenticando para o OMERO Downloader
50+
51+
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`.
52+
53+
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, você pode verificar as suas chaves de sessão usando:
54+
55+
```bash
56+
omero sessions list
57+
```
58+
59+
Para mais detalhes, consulte a página de documentação do [OMERO Downloader](/src/07-programas-e-aplicativos/omero-downloader/README.md).
60+

‎src/07-programas-e-aplicativos/omero-downloader/README.md‎

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ module load omero-downloader
1717
<div class="warning">
1818
<br>As versões disponíveis do OMERO Downloader no HPCC Marvin são:
1919
<ul>
20-
<li><code>omero-downloader/0.3.3 (D)</code></li>
20+
<li><code>omero-downloader/0.2.2 (D)</code></li>
2121
</ul>
2222
Onde <code>(D)</code> indica a versão padrão.<br>
2323
</div>
@@ -34,12 +34,49 @@ Para acessar a documentação completa dos parâmetros do OMERO Downloader, exec
3434
omero-downloader --help
3535
```
3636

37+
## Realizando login
38+
39+
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`.
40+
41+
Para isso, carregue o módulo do OMERO CLI:
42+
43+
```bash
44+
ml load omero
45+
```
46+
47+
Em seguida, execute o comando de login:
48+
49+
```bash
50+
omero login -s omero-lnbio.cnpem.br -u <user_name>
51+
```
52+
53+
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.
54+
55+
Para verificar as suas chaves de sessão, use:
56+
57+
```bash
58+
omero sessions list
59+
```
60+
61+
Você verá algo como isso:
62+
63+
```bash
64+
$ omero sessions list
65+
Server | User | Group | Session | Active | Started
66+
----------------------+----------+-------+--------------------------------------+-----------+--------------------------
67+
omero-lnbio.cnpem.br | analista | LIB | b22d1f3c-e7f3-4cb4-afea-4ce656d82dab | Logged in | Mon Mar 2 15:29:09 2026
68+
(1 row)
69+
```
70+
71+
No exemplo acima, você utilizaria a chave de sessão `b22d1f3c-e7f3-4cb4-afea-4ce656d82dab` com a opção `-k` do OMERO Downloader.
72+
73+
3774
## Baixando dados
3875

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

4178
```bash
42-
omero-downloader -b <output_dir> -s omero-lnbio.cnpem.br -u <user_name> -w <password> -f <file> <type>:<ID>
79+
omero-downloader -b <output_dir> -k <session_key> -f <file> <type>:<ID>
4380
```
4481

4582
<div class="warning">
@@ -52,31 +89,33 @@ omero-downloader -b <output_dir> -s omero-lnbio.cnpem.br -u <user_name> -w <pass
5289
<li><code>&lt;file&gt;</code>: formato do arquivo a ser baixado. O formato recomendado é <code>ome-tiff</code>; outros formatos estão disponíveis na documentação de parâmetros do OMERO Downloader.</li>
5390
<li><code>&lt;type&gt;</code>: tipo de objeto que você deseja baixar:
5491
<ul>
55-
<li><code>Image</code>: arquivo de imagem único.</li>
56-
<li><code>Dataset</code>: conjunto de arquivos de imagem.</li>
57-
<li><code>Project</code>: conjunto de datasets.</li>
92+
<li><code>Image</code>: imagem individual</li>
93+
<li><code>Plate</code>: placa de experimentos multi-poços</li>
94+
<li><code>Screen</code>: conjunto de placas</li>
95+
<li><code>Dataset</code>: conjunto de arquivos de imagem</li>
96+
<li><code>Project</code>: conjunto de datasets</li>
5897
</ul>
5998
</li>
60-
<li><code>&lt;ID&gt;</code>: número de identificação do objeto que deseja baixar.</li>
99+
<li><code>&lt;ID&gt;</code>:identificador numérico do objeto no OMERO..</li>
61100
</ul>
62101
</div>
63102

64103
Para baixar uma imagem, use:
65104

66105
```bash
67-
omero-downloader -b /home/marie.curie/pasta_destino -s omero-lnbio.cnpem.br -u marie.curie -w minhasenha123 -f ome-tiff Image:123
106+
omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Image:123
68107
```
69108

70109
Para baixar um _Dataset_, use:
71110

72111
```bash
73-
omero-downloader -b /home/marie.curie/pasta_destino -s omero-lnbio.cnpem.br -u marie.curie -w minhasenha123 -f ome-tiff Dataset:123
112+
omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Dataset:123
74113
```
75114

76115
Para baixar um projeto, use:
77116

78117
```bash
79-
omero-downloader -b /home/marie.curie/pasta_destino -s omero-lnbio.cnpem.br -u marie.curie -w minhasenha123 -f ome-tiff Project:123
118+
omero-downloader -b /home/marie.curie/pasta_destino -k <session_key> -f ome-tiff Project:123
80119
```
81120

82121
<div class="warning">

‎src/SUMMARY.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@
4747
- [NP³ MS WORKFLOW](07-programas-e-aplicativos/np3_ms_workflow/README.md)
4848
- [Criando Sbatch](07-programas-e-aplicativos/np3_ms_workflow/np3_sbatch.md)
4949
- [Usando o Job Composer](07-programas-e-aplicativos/np3_ms_workflow/np3_jobcomposer.md)
50+
- [OMERO-CLI](07-programas-e-aplicativos/omero-cli/README.md)
5051
- [OMERO Downloader](07-programas-e-aplicativos/omero-downloader/README.md)
5152
- [Pairix](07-programas-e-aplicativos/pairix/README.md)
5253
- [pairtools](07-programas-e-aplicativos/pairtools/README.md)

0 commit comments

Comments
 (0)