Merge pull request #57 from ResidenciaTICBrisa/caiozim112.fixreadme

Co-authored-by: Pedro Henrique Braga <[email protected]>
ResidenciaTICBrisa · Aug 15, 2023 · dde9b66 · dde9b66
2 parents 7044828 + bc7903f
commit dde9b66
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -12,11 +12,53 @@ Esse projeto pode ser utilizado para modelar diferentes cenários de transição
 
 ## 2. Resultados Esperados
 
-levantamento de dados públicos de fontes nacionais e internacionais, arquitetura, análises e propostas de curva de custo marginal de abatimento de carbono das diversas alternativas para transição energética brasileira.
+levantamento de dados públicos de fontes nacionais e internacionais, arquitetura, análises e propostas de curva de custo marginal de abatimento de carbono das diversas alternativas para transição energética brasileira, de forma a auxiliar a auditoria do processo, realizado pelo MCTI e MME, pelo TCU.
 
+## 3. Estrutura do Projeto
 
-## 3. Colaboradores
+- A documentação do Projeto foi contruido utilizando o Github Pages e estruturada para seguir o modelo de atas, que documentam o projeto em sua respectiva etapas.
 
+## 4. Tecnologias
+
+| | Ferramenta | Finalidade |
+| :------: | :----------: | :---------------------------------------------------: |
+| <img src="https://user-images.githubusercontent.com/49570180/152992872-979c7996-a495-410e-bdc9-71509b246191.png" width="250" title="Github">| GitHub | Hospedagem do repositório para o projeto |
+| <img src="https://user-images.githubusercontent.com/49570180/152992930-c5d81a68-9079-4aa7-8ae0-5d396bb4f7b3.png" width="250" title="Teams">| Microsoft Teams | Reunião da equipe para gravar as apresentações |
+| <img src="https://user-images.githubusercontent.com/49933115/139837223-bf23d3a9-4638-4e17-994a-ac8678d5f517.png" width="100" title="Telegram">| Telegram | Utilização de grupo para comunicação entre os integrantes da equipe |
+|<img src="https://user-images.githubusercontent.com/71900095/189494621-28704ee5-61c6-45b5-87b1-bb5ffa2d7301.png" height= 70 width=70> | Excel| Aplicativo para disponibilização dos horários disponíveis de cada integrante. |
+ <img src="https://github.com/ResidenciaTICBrisa/04_PipelineTCU/assets/51385738/6eb51389-b2eb-45aa-99b2-0f32613e3739" width="100" title="Power Automate">| Power Automate | Automatização de tarefas 
+|<img src="https://github.com/ResidenciaTICBrisa/04_PipelineTCU/assets/98167728/83dba75c-712f-4348-aff3-bf3142b5a895" height= 40 width=40> | PowerBI | Ferramenta para exibição de gráficos e tabelas |
+|<img src="https://assets.asana.biz/transform/ba9b63a3-f255-4088-b5fe-14ab4628f50b/logo-app-figma" height= 40 width=40s> | Figma | Ferramenta para prototipagem, elaboração de roadmaps e backlog. |
+|<img src="https://raw.githubusercontent.com/Interacao-Humano-Computador/2022.1-Millenium-Papelaria/15adf26be163cb9b95a5d6cbaee79fc034a506ab/docs/images/ferramentas/vscode.svg" height= 90 width=90> | Visual Studio Code | Edição dos artefatos |
+
+
+## 5. Visualização do PowerBi e Fontes de Dados
+
+Por Questões de Permissão disponíveis apenas para membros da organização "@unb.br"
+
+[Visualização](https://unbbr.sharepoint.com/sites/PipelineTCU)
+
+
+## 6. Rodando o Projeto
+
+### Clonando o Projeto
+
+```bash
+$ git clone https://github.com/ResidenciaTICBrisa/04_PipelineTCU.git
+$ cd 04_PipelineTCU
+```
+
+### Instalando o Python
+
+[https://git-scm.com/downloads](https://git-scm.com/downloads)
+
+
+### Rodando os scripts em Python
+```bash
+$ python3 "nome_do_arquivo".py
+```
+
+## 7. Colaboradores
 
 <table>
   <tr>
@@ -60,16 +102,15 @@ levantamento de dados públicos de fontes nacionais e internacionais, arquitetur
         </sub>
       </a>
     </td>
-
 </table>
 
 <br/> 
 
-## 4. Papéis
+## 8. Papéis
 | Membro | Papel |
 |--- |--- |
 | Caio Vitor | Community Manager |
 | Eduardo Gurgel | Product Manager |
 | Pedro Braga | Scrum master |
 | Ugor Costa | Líder Técnico |
-| Victório Lázaro | Devops/Arquitetura |  
+| Victório Lázaro | Devops/Arquitetura |  
diff --git a/docs/cronograma/cronograma.md b/docs/cronograma/cronograma.md
@@ -13,6 +13,8 @@
 |   3   |        Relatório/Apresentação Final         |                                              <p style="text-align: justify;">Criação do Relatório que será apresentado ao final do Projeto </p>                                              |  27/10  |    27/11     |
 <figcaption align="center">Tabela 1 - Cronograma geral da equipe.</figcaption>
 
+**OBS:** A Respectiva Etapas das sprints estão documentadas na ata de [Comunicação](https://residenciaticbrisa.github.io/04_PipelineTCU/comunicacao/documentacao_sprints/etapa1/etapa1/)
+
 ## Histórico de versão
 
 | Versão |    Data    |                       Descrição                       |      Autor       |

diff --git a/docs/index.md b/docs/index.md
@@ -1,25 +1,64 @@
 # Pipeline de Dados
 Pipeline de dados e análises para modelagem de curvas de custo de marginal de abatimento do carbono das diversas alternativas do setor energético brasileiro para fins de suportar avaliação de custo-efetividade de políticas de transição energética do país.
 
-**Habilidades necessárias/preferenciais:** conhecimento em python
-
 **Mentores:** Aline, TCU
 
-**Tamanho do projeto:** Médio/Grande
-
-**Dificuldade:** Grande
-
 
 ## 1. Sobre o projeto
-OBS: o próprio MCTI tinha iniciado uma ação nesse sentido mas não sabemos a evolução ou se foi atualizada [https://antigo.mctic.gov.br/mctic/opencms/ciencia/SEPED/clima/opcoes_mitigacao/paginas/potenciais_custos_abatimento_setoriais.html](https://antigo.mctic.gov.br/mctic/opencms/ciencia/SEPED/clima/opcoes_mitigacao/paginas/potenciais_custos_abatimento_setoriais.html). Acredito que com o apoio dos professores dos laboratórios de software e energia poderíamos ter um resultado legal que nos apoiasse em nossas análises.
+O pipeline de dados é um projeto que tem o objetivo de reunir fontes de dados em um painel centralizado e eficiente, possibilitando a coleta, processamento e transformação de informações de diversas origens.
+No contexto da transição energética brasileira, o pipeline de dados desempenha um papel fundamental, à medida que o Brasil se compromete com a transformação de sua matriz energética até o ano de 2050, surge a necessidade de monitorar, analisar e tomar decisões informadas se torna ainda mais crucial.
+Esse projeto pode ser utilizado para modelar diferentes cenários de transição energética, levando em consideração variáveis como investimentos em infraestrutura, impactos ambientais e socioeconômicos. Essa análise abrangente auxilia na formulação de estratégias políticas e na definição de metas realistas para alcançar os objetivos da transição até 2050.
+
 
 ## 2. Resultados Esperados
 
-levantamento de dados públicos de fontes nacionais e internacionais, arquitetura, análises e propostas de curva de custo marginal de abatimento de carbono das diversas alternativas para transição energética brasileira.
+levantamento de dados públicos de fontes nacionais e internacionais, arquitetura, análises e propostas de curva de custo marginal de abatimento de carbono das diversas alternativas para transição energética brasileira, de forma a auxiliar a auditoria do processo, realizado pelo MCTI e MME, pelo TCU.
+
+## 3. Estrutura do Projeto
+
+- A documentação do Projeto foi contruido utilizando o Github Pages e estruturada para seguir o modelo de atas, que documentam o projeto em sua respectiva etapas.
+
+## 4. Tecnologias
+
+| | Ferramenta | Finalidade |
+| :------: | :----------: | :---------------------------------------------------: |
+| <img src="https://user-images.githubusercontent.com/49570180/152992872-979c7996-a495-410e-bdc9-71509b246191.png" width="250" title="Github">| GitHub | Hospedagem do repositório para o projeto |
+| <img src="https://user-images.githubusercontent.com/49570180/152992930-c5d81a68-9079-4aa7-8ae0-5d396bb4f7b3.png" width="250" title="Teams">| Microsoft Teams | Reunião da equipe para gravar as apresentações |
+| <img src="https://user-images.githubusercontent.com/49933115/139837223-bf23d3a9-4638-4e17-994a-ac8678d5f517.png" width="100" title="Telegram">| Telegram | Utilização de grupo para comunicação entre os integrantes da equipe |
+|<img src="https://user-images.githubusercontent.com/71900095/189494621-28704ee5-61c6-45b5-87b1-bb5ffa2d7301.png" height= 70 width=70> | Excel| Aplicativo para disponibilização dos horários disponíveis de cada integrante. |
+ <img src="https://github.com/ResidenciaTICBrisa/04_PipelineTCU/assets/51385738/6eb51389-b2eb-45aa-99b2-0f32613e3739" width="100" title="Power Automate">| Power Automate | Automatização de tarefas 
+|<img src="https://github.com/ResidenciaTICBrisa/04_PipelineTCU/assets/98167728/83dba75c-712f-4348-aff3-bf3142b5a895" height= 40 width=40> | PowerBI | Ferramenta para exibição de gráficos e tabelas |
+|<img src="https://assets.asana.biz/transform/ba9b63a3-f255-4088-b5fe-14ab4628f50b/logo-app-figma" height= 40 width=40s> | Figma | Ferramenta para prototipagem, elaboração de roadmaps e backlog. |
+|<img src="https://raw.githubusercontent.com/Interacao-Humano-Computador/2022.1-Millenium-Papelaria/15adf26be163cb9b95a5d6cbaee79fc034a506ab/docs/images/ferramentas/vscode.svg" height= 90 width=90> | Visual Studio Code | Edição dos artefatos |
+
+
+## 5. Visualização do PowerBi e Fontes de Dados
+
+Por Questões de Permissão disponíveis apenas para membros da organização "@unb.br"
+
+[Visualização](https://unbbr.sharepoint.com/sites/PipelineTCU)
+
+
+## 6. Rodando o Projeto
+
+### Clonando o Projeto
+
+```bash
+$ git clone https://github.com/ResidenciaTICBrisa/04_PipelineTCU.git
+$ cd 04_PipelineTCU
+```
+
+### Instalando o Python
+
+[https://git-scm.com/downloads](https://git-scm.com/downloads)
 
 
-## 3. Colaboradores
+### Rodando os scripts em Python
+```bash
+$ python3 "nome_do_arquivo".py
+```
 
+## 7. Colaboradores
 
 <table>
   <tr>
@@ -63,16 +102,15 @@ levantamento de dados públicos de fontes nacionais e internacionais, arquitetur
         </sub>
       </a>
     </td>
-
 </table>
 
 <br/> 
 
-## 4. Papéis
+## 8. Papéis
 | Membro | Papel |
 |--- |--- |
 | Caio Vitor | Community Manager |
 | Eduardo Gurgel | Product Manager |
 | Pedro Braga | Scrum master |
 | Ugor Costa | Líder Técnico |
-| Victório Lázaro | Devops/Arquitetura |  
+| Victório Lázaro | Devops/Arquitetura |