diff --git a/docs/basic_training/orientation.pt.md b/docs/basic_training/orientation.pt.md new file mode 100644 index 00000000..7e1d1ddb --- /dev/null +++ b/docs/basic_training/orientation.pt.md @@ -0,0 +1,93 @@ +--- +title: Orientação +description: Como configurar um ambiente de desenvolvimento para executar Nextflow +--- + +# Orientação + +O ambiente do Gitpod contem dados de teste que serão utilizados nesse treinamento. + +!!! note + + Vá [para este link](../envsetup/index.pt.md) se você ainda não configurou seu ambiente no Gitpod. + +## Começando + +Você irá completar esse módulo na pasta `nf-training/`. + +Nessa pasta você irá encontrar vários arquivos de dados (`ggal`, `index`, `meta`...) e também alguns scripts e arquivos de configuração. + +```console +. +├── data +│ ├── ggal +│ │ └── +│ ├── index +│ │ └── +│ ├── meta +│ │ └── +│ ├── prots +│ │ └── +│ ├── reads +│ │ └── +│ └── test +│ └── +├── env.yml +├── hello.nf +├── hello_py.nf +├── modules.hello.nf +├── nextflow.config +├── script1.nf +├── script2.nf +├── script3.nf +├── script4.nf +├── script5.nf +├── script6.nf +├── script7.nf +└── snippet.nf +``` + +Cada arquivo será utilizado nesse treinamento. + +## Escolhendo uma versão do Nextflow + +Por padrão, o Nextflow irá trazer a última versão estável para seu ambiente. + +No entanto, Nextflow vive em uma evolução constante na medida que melhorias são implementadas. + +As últimas versões podem ser conferidas no GitHub, [aqui](https://github.com/nextflow-io/nextflow/releases). + +Se você deseja utilizar uma versão específica do Nextflow, você pode configurar a variável `NXF_VER` como mostrado abaixo: + +```bash +export NXF_VER=23.10.1 +``` + +!!! question "Exercise" + + Abra o [ambiente de treinamento no Gitpod](https://gitpod.io/#https://github.com/nextflow-io/training) e use o seguinte comando para ir até a pasta `nf-customize`. Visualize os arquivos nessa pasta utilizando o comando `tree`: + + ```bash + cd /workspace/gitpod/nf-training + tree . + ``` + +## Variáveis do ambiente + +Por padrão, o Nextflow irá trazer a última versão estável para seu ambiente. + +No entanto, Nextflow vive em uma evolução constante na medida que melhorias são implementadas. + +As últimas versões podem ser conferidas no GitHub, [aqui](https://github.com/nextflow-io/nextflow/releases). + +Se você deseja utilizar uma versão específica do Nextflow, você pode configurar a variável `NXF_VER` como mostrado abaixo: + +```bash +export NXF_VER=23.10.1 +``` + +!!! note + + Esse material requer uma versão igual ou posterior a `NXF_VER=23.10.1`. + +Se você exportou a variável `NXF_VER` como acima, execute `nextflow -version` novamente para confirmar que suas mudanças foram aplicadas. diff --git a/docs/envsetup/01_setup.pt.md b/docs/envsetup/01_setup.pt.md new file mode 100644 index 00000000..4774b4f1 --- /dev/null +++ b/docs/envsetup/01_setup.pt.md @@ -0,0 +1,66 @@ +# Gitpod + +Gitpod é um ambiente de desenvolvimento em nuvem feito para equipes desenvolverem software de forma segura e eficiente. Ele pode aprimorar sua experiência de desenvolvedor ao possibilitar que programe em um ambiente de desenvolvimento em nuvem. + +## Criando uma conta no Gitpod + +Você pode criar uma conta gratuita no [Gitpod](https://gitpod.io/) usando sua conta pré-existente no GitLab, GitHub ou Bitbucket. + +Você pode criar uma conta usando a [página de login do Gitpod](https://gitpod.io/login/). + +![Gitpod log in](img/login.png) + +Recomendamos que conecte sua conta do LinkedIn para receber um tempo adicional de uso de 50 horas. + +![Gitpod log in one step](img/onestepaway.png) + +Depois de selecionar seu editor e tema preferidos e conferir os detalhes do seu perfil, clique em continuar e sua conta será criada e já estará pronta para uso. + +!!! note + + Recomendamos que utilize o editor de texto VS Code. + +## Executando o Gitpod + +Clique na URL a seguir para executar o Gitpod: + +Essa URL é o repositório de treinamento do Nextflow prefixado com `https://gitpod.io/#`. + +Você também pode acessar o material clicando no botão abaixo. + +[![Open Gitpod](https://img.shields.io/badge/Gitpod-%20Open%20in%20Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/nextflow-io/training) + +Se você já estiver logado, seu ambiente no Gitpod começará a carregar. + +### Explore sua IDE no Gitpod + +Após o carregamento concluir, você poderá ver algo semelhante a isso: + +![Gitpod welcome](img/gitpod.welcome.png) + +- **A barra lateral** permite que você customize seu ambiente Gitpod e realize tarefas básicas (copiar, colar, abrir arquivos, buscar, git, etc.). Você pode clicar no explorador para ver que arquivos estão presentes em seu repositório. +- **O terminal** permite que você execute todos os programas no repositório. Por exemplo, `nextflow` e `docker` estão instalados e podem ser executados. +- **O explorador de arquivos** permite que você visualize e edite arquivos. Clicar em um arquivo no explorador irá abri-lo na janela principal. +- **O navegador** permite que você visualize o material de treinamento (). Caso o feche acidentalmente, você pode iniciar o navegador novamente executando o seguinte comando no terminal: `gp preview https://training.nextflow.io`. + +### Recursos do Gitpod + +O Gitpod fornece 500 créditos gratuitos por mês, o que é equivalente a 50 horas de uso gratuito do ambiente de execução usando a área de trabalho padrão (até 4 núcleos, 8 GB de RAM e 30 GB de armazenamento). + +Também há a opção de uma área de trabalho maior, que fornece até 8 núcleos, 16 GB de RAM e 50 GB de armazenamento. No entanto, essa área de trabalho maior irá utilizar seus recursos mais rapidamente e você terá menos horas de acesso a ela. + +O ambiente Gitpod irá pausar após 30 minutos de inatividade e salvará suas mudanças por até 2 semanas. + +Mais informação sobre o Gitpod está disponível em [gitpod.io](https://www.gitpod.io). + +### Reiniciando uma sessão no Gitpod + +Você pode reiniciar um ambiente na página . Ambientes anteriores serão listados nessa página. Basta selecionar a elipse (os três pontos) e então eselcionar `Open` para reiniciar um ambiente anterior. + +Se você salvou a URL de um ambiente anterior do Gitpod, para reiniciá-lo basta abrir a URL em seu navegador. + +Você também pode apenas iniciar um novo ambiente de treinamento na URL a seguir: + +### Salvando arquivos do Gitpod na sua máquina local + +Para salvar qualquer arquivo do painel do explorador, clique no arquivo com o botão direito do mouse e selcione `Download`. diff --git a/docs/envsetup/02_local.pt.md b/docs/envsetup/02_local.pt.md new file mode 100644 index 00000000..66985321 --- /dev/null +++ b/docs/envsetup/02_local.pt.md @@ -0,0 +1,90 @@ +# Instalação local + +Se você **não conseguiu** acessar o Gitpod, uma alternativa é instalar tudo localmente. + +Alguns dos requisitos podem ser diferentes, a depender da sua máquina local. + +## Requisitos + +Nextflow pode ser utilizado em qualquer sistema compatível com o POSIX (Linux, macOS, Subsistema Linux para Windows, etc.). + +**Requisitos** + +- Bash +- [Java 11 (ou posterior, até o 21)](https://www.oracle.com/technetwork/java/javase/downloads/index.html) +- [Git](https://git-scm.com/) +- [Docker](https://docs.docker.com/get-docker/) + +**Requisitos opcionais** + +- [Singularity](https://github.com/sylabs/singularity) 2.5.x (ou posterior) +- [Conda](https://conda.io/) 4.5 (ou posterior) +- [Graphviz](http://www.graphviz.org/) +- [AWS CLI](https://aws.amazon.com/cli/) +- Um ambiente computacional configurado no AWS Batch + +## Baixando Nextflow + +Execute esse comando em seu terminal: + +```bash +wget -qO- https://get.nextflow.io | bash +``` + +Você também pode usar o comando `curl`: + +```bash +curl -s https://get.nextflow.io | bash +``` + +Em seguida, garanta que o binário baixado é executável: + +```bash +chmod +x nextflow +``` + +Por fim, garanta que o executável do `nextflow` está na sua `$PATH`. O executável pode estar presente em `/usr/local/bin`, `/bin/`, etc. + +## Docker + +Garanta que o Docker Desktop está rodando em sua máquina. Você pode baixar o Docker [aqui](https://docs.docker.com/get-docker/). + +## Material de treinamento + +Você pode ver o material de treinamento [aqui](https://training.nextflow.io/). + +Para baixar o material, execute esse comando: + +```bash +git clone https://github.com/nextflow-io/training.git +``` + +Então use `cd` para entrar no diretório `nf-training`. + +## Verificando sua instalação + +Verifique que você instalou `nextflow` corretamente executando o seguinte comando: + +```bash +nextflow info +``` + +Esse comando deve imprimir a versão, o sistema e o ambiente de execução atuais. + +!!! question "Exercise" + + Para testar que seu ambiente está funcionando corretamente, execute o seguinte comando: + + ```bash + nextflow info + ``` + + Esse comando deve trazer informação sobre a versão do Nextflow e sobre seu ambiente de execução: + + ```console + Version: 23.10.1 build 5891 + Created: 12-01-2024 22:01 UTC + System: Linux 6.1.75-060175-generic + Runtime: Groovy 3.0.19 on OpenJDK 64-Bit Server VM 11.0.1-internal+0-adhoc..src + Encoding: UTF-8 (UTF-8) + ``` diff --git a/docs/envsetup/index.pt.md b/docs/envsetup/index.pt.md new file mode 100644 index 00000000..d7f6f9aa --- /dev/null +++ b/docs/envsetup/index.pt.md @@ -0,0 +1,11 @@ +# Configuração do ambiente + +Os cursos de treinamento oferecidos no portal de treinamento da comunidade de Nextflow são otimizados para uso dentro do nosso ambiente Gitpod. + +O Gitpod oferece uma máquina virtual com tudo já configurado para seu uso, acessável através do seu navegador ou integrados com seu editor de texto (por exemplo, VSCode). + +Se você já possui uma conta no Gitpod, clique no botão abaixo, caso contrário, continue nesse módulo para configurar sua conta. + +Vamos começar! + +[![Abra no Gitpod](https://img.shields.io/badge/Gitpod-%20Open%20in%20Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/nextflow-io/training)