summaryrefslogtreecommitdiffstats
path: root/docusaurus/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docusaurus/docs')
-rw-r--r--docusaurus/docs/aboutPSP.md4
-rw-r--r--docusaurus/docs/cadTools.md78
-rw-r--r--docusaurus/docs/installation.md4
-rw-r--r--docusaurus/docs/mainScreen.md6
-rw-r--r--docusaurus/docs/powerEditor.md23
5 files changed, 110 insertions, 5 deletions
diff --git a/docusaurus/docs/aboutPSP.md b/docusaurus/docs/aboutPSP.md
index 4535845..36de9a5 100644
--- a/docusaurus/docs/aboutPSP.md
+++ b/docusaurus/docs/aboutPSP.md
@@ -10,7 +10,7 @@ This user guide was written in Brazilian Portuguese. If you want to help me tran
## Sobre o PSP-UFU
-O PSP-UFU (Plataforma de Sistemas de Potência da Universidade Federal de Uberlândia) é um software **multi-plataforma**, **multilíngue**, **livre e de código aberto (FOSS)** com **recursos avançados de GUI (Interface Gráfica do Usuário)** e **ferramentas CAD (Design Assistido por Computador)** para estudos de sistemas elétricos de potência.
+O PSP-UFU (Plataforma de Sistemas de Potência da Universidade Federal de Uberlândia) é um software **multi-plataforma**, **multilíngue**, **livre e de código aberto (FOSS)** com **recursos avançados de GUI (*Graphical User Interface*)** e **ferramentas CAD (*Computer Aided Design*)** para estudos de sistemas elétricos de potência.
O software permite a construção de qualquer rede de transmissão elétrica e sistemas de controle através da inserção de elementos visuais. Para a visualização dos resultados, o programa oferece **elementos de texto vinculados** na tela principal e também **editores de tabelas e gráficos**.
@@ -23,7 +23,7 @@ Resumidamente, o *software* pode executar os seguintes estudos:
- Harmônicos
- Estabilidade transitória e dinâmica
-### Artigos publicados e Tese de doutorado
+### Publicações
Os artigos abaixo possuem maiores detalhes a respeito do PSP-UFU:
>Oliveira, T. L., Guimarães, G. C., & Silva, L. R. C. (2019). PSP-UFU: An open-source, graphical, and multiplatform software for power system studies. *International Transactions on Electrical Energy Systems*, e12185. doi: [10.1002/2050-7038.12185](https://doi.org/10.1002/2050-7038.12185)
diff --git a/docusaurus/docs/cadTools.md b/docusaurus/docs/cadTools.md
index a66d0f2..97b608b 100644
--- a/docusaurus/docs/cadTools.md
+++ b/docusaurus/docs/cadTools.md
@@ -3,9 +3,87 @@ id: cadTools
title: Ferramentas CAD
sidebar_label: Ferramentas CAD
---
+export const Highlight = ({children, color}) => ( <span style={{
+ backgroundColor: color,
+ borderRadius: '2px',
+ color: '#000',
+ padding: '0.2rem',
+ }}>{children}</span> );
+>Desenho assistido por computador (DAC; em inglês: *computer aided design* - CAD) é o nome genérico de sistemas computacionais (*software*) utilizados pela engenharia, geologia, geografia, arquitetura e design para facilitar o projeto e desenho técnicos. No caso do *design*, este pode estar ligado especificamente a todas as suas vertentes (produtos como vestuário, eletroeletrônicos, automobilísticos, etc.), de modo que os jargões de cada especialidade são incorporados na interface de cada programa. [Wikipedia](https://pt.wikipedia.org/wiki/Desenho_assistido_por_computador#cite_note-1)
+
+Todos os objetos criados contêm vários atributos gráficos, como: posição, orientação, cor, tamanho, etc. Para modificá-los foram inseridas algumas ferramentas intuitivas e de fácil utilização, as quais são: [**selecionar**](cadTools#selecionar), [**mover**](cadTools#mover), [**girar**](cadTools#girar), [**arrastar**](cadTools#arrastar), [**zoom**](cadTools#zoom), [**encaixar**](cadTools#encaixar), [**copiar, colar**](cadTools#copiar-e-colar) e [**excluir**](cadTools#excluir).
+
+Tais ferramentas permitem a **personalização**, **navegação** e auxiliam a **criação** de redes elétricas de potência, assim como diagramas de controle na plataforma.
+
+### Selecionar
+A seleção de um único objeto é realizada clicando com o botão esquerdo do mouse sobre o elemento, que será identificado pelo contorno em <Highlight color="#80bfff">azul</Highlight> do objeto.
+
+Para a seleção de vários objetos simultaneamente é necessário clicar com o botão esquerdo do mouse em um local vazio da tela e arrastá-lo, criando assim um **retângulo de seleção** que irá acompanhar o ponteiro do mouse enquanto o botão esquerdo estiver pressionado. Ao soltá-lo todos os objetos que intercederem o retângulo serão selecionados.
+
+Mantendo pressionado a tecla Control (Ctrl) do teclado pode-se manter seleções anteriores enquanto novos elementos são selecionados.
+
+Para desmarcar todos os objetos basta clicar em uma área sem objetos.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/select.mp4" type="video/mp4" />
+</video>
+
+### Mover
+Um elemento poderá ser movido para qualquer local por meio da ação *drag-and-drop* (clicando e arrastando) ou pela ferramenta mover.
+
+Ao habilitar o “modo mover”, movendo todos os componentes selecionados à medida que a posição do mouse é alterada. Para desabilitar esse modo basta pressionar a tecla Escape do teclado.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/move.mp4" type="video/mp4" />
+</video>
+
+### Girar
+Alguns objetos poderão ser rotacionados através da ferramenta girar, acessado pela tecla de atalho “R”, girando o objeto no sentido horário, ou “Shift + R”, para o sentido anti-horário (essa opção irá afetar todos os objetos selecionados).
+
+Ao utilizar essa ferramenta os objetos irão girar 45º a partir do seu ponto de origem. Para atingir a angulação pretendida basta repetir o processo de rotação.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/rotate.mp4" type="video/mp4" />
+</video>
+
+### Arrastar
+Três ferramentas muito úteis na navegação do circuito, principalmente em grandes redes, são: arrastar, zoom e encaixar.
+
+A ferramenta arrastar possibilita mover todo o circuito **preservando as posições relativas entre os elementos**. Esta ferramenta pode ser acessada pelo submenu “Ferramentas” ou **mantendo pressionada o scroll do mouse**, ativando assim o “modo arrastar”. Ao ativá-lo todo o circuito será movido clicando e arrastando na direção desejada.
+
+Para sair do “modo arrastar” basta pressionar a tecla Escape do teclado.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/drag.mp4" type="video/mp4" />
+</video>
### Zoom
+O zoom será aplicado ao utilizar o **scroll do mouse** para mais ou menos zoom. A ferramenta zoom irá aproximar ou distanciar o circuito a partir da posição do ponteiro do mouse na tela para encontrar objetos ou destaca-los.
+
<video autoPlay loop muted controls>
<source src= "/PSP/videos/zoom.mp4" type="video/mp4" />
</video>
+
+### Encaixar
+A ferramenta encaixar irá mover o circuito e aplicar o zoom necessário para que todos os componentes da rede sejam exibidos na tela. Esta ferramenta pode ser acessada através do submenu “Ferramentas” ou pela combinação de teclas “Shift + F”.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/fit.mp4" type="video/mp4" />
+</video>
+
+### Copiar e Colar
+Duas ferramentas importantes durante o processo de criação da rede elétrica de potência no *software* são copiar e colar. Qualquer circuito criado no PSP-UFU, poderá ser duplicado completamente ou parcialmente no mesmo projeto ou em múltiplos através dessas ferramentas.
+
+Para copiar basta selecionar os elementos que se deseja duplicar e acessar a ferramenta no submenu “Ferramentas” ou pressionando a combinação das teclas “Ctrl + C”, então os dados do circuito serão copiados para a área de transferência. Ao copiar um circuito ele poderá ser colado no mesmo projeto ou em um projeto distinto, utilizando o mesmo submenu ou pressionando a combinação das teclas “Ctrl + V”.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/copyPaste.mp4" type="video/mp4" />
+</video>
+
+### Excluir
+Qualquer objeto poderá ser excluído do projeto por meio da ferramenta deletar, presente no menu Ribbon, ou pela tecla de atalho Delete.
+
+<video autoPlay loop muted controls>
+ <source src= "/PSP/videos/delete.mp4" type="video/mp4" />
+</video> \ No newline at end of file
diff --git a/docusaurus/docs/installation.md b/docusaurus/docs/installation.md
index 0ae22e8..b99fb00 100644
--- a/docusaurus/docs/installation.md
+++ b/docusaurus/docs/installation.md
@@ -10,7 +10,7 @@ O download do PSP-UFU pode ser realizado pelo ["*last release*" do repositório
Ao acessar ao link, role a página até encontrar os *Assets*:
![Download][download]
-[download]: /PSP/images/download.png 'Assets donwload'
+[download]: /PSP/images/download.png 'Assets download'
Como o PSP-UFU é um *software* multiplataforma, você deve baixar o arquivo correto:
- Para o sistema operacional [Windows](installation#windows) baixe os arquivos *.exe* (recomendado) ou *.zip*.
@@ -56,7 +56,7 @@ echo "export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib" >> ~/.bashrc
#### *Método II (não recomendado)*
:::warning Cuidado!
-Utilizando esse método, os passos abaixo devem ser executados todas as vezes que você quiser abir o PSP-UFU.
+Utilizando esse método os passos abaixo devem ser executados **todas as vezes** que você quiser abrir o PSP-UFU.
:::
1. Abra o terminal e acesse o diretório onde está instalado o PSP-UFU:
```shell
diff --git a/docusaurus/docs/mainScreen.md b/docusaurus/docs/mainScreen.md
index dd5c9f0..63007a5 100644
--- a/docusaurus/docs/mainScreen.md
+++ b/docusaurus/docs/mainScreen.md
@@ -42,4 +42,8 @@ As edições gráficas dos elementos, como posição, conexão e tamanho dos bar
[workspace]: /PSP/images/workspace.png 'Área de Trabalho'
### Barra de Status
-A barra de status é responsável por informações interessantes sobre as circunstâncias atuais do programa: modo de operação do mouse (editar, mover, arrastar), zoom aplicado e posição do mouse na área de trabalho, além de dados sobre as ações dos usuários, como: inserção de elementos, informação sobre copiar e colar, etc. \ No newline at end of file
+A barra de status é responsável por informações interessantes sobre as circunstâncias atuais do programa: modo de operação do mouse (editar, mover, arrastar), zoom aplicado e posição do mouse na área de trabalho, além de dados sobre as ações dos usuários, como: inserção de elementos, informação sobre copiar e colar, etc.
+
+:::tip Dica
+**Sempre fique atendo à barra de status**, pois são fornecidas informações importantes acerca da operação do programa. Caso tenha alguma dúvida siga as instruções apresentadas nesse componente.
+::: \ No newline at end of file
diff --git a/docusaurus/docs/powerEditor.md b/docusaurus/docs/powerEditor.md
new file mode 100644
index 0000000..73bd0f7
--- /dev/null
+++ b/docusaurus/docs/powerEditor.md
@@ -0,0 +1,23 @@
+---
+id: powerEditor
+title: Editor de Potência
+sidebar_label: Editor de Potência
+---
+
+A criação de um novo projeto é realizada clicando no item **Novo projeto** no submenu [**Arquivo**](mainScreen#menu-ribbon). Essa ação cria um sistema em branco na área de trabalho, local onde é possível inserir os elementos elétricos por meio do submenu **Ferramentas**.
+
+![Adicionar elementos de potência][addPowerElements]
+[addPowerElements]: /PSP/images/addPowerElements.png 'Adicionar elementos de potência'
+
+No caso de inserção de um barramento, o usuário deve apenas clicar na posição desejada, já para os outros componentes será solicitado que o usuário selecione em uma ou duas barras, o qual o novo componente será conectado.
+
+Sempre que são inseridos novos elementos, um formulário de dados é exibido e pode-se editar os dados elétricos e acessar formulários adicionais, como dados de estabilidade.
+
+:::caution Atenção
+O primeiro elemento que a ser inserido no projeto **deve** ser um barramento. Os demais elementos elétricos deve ser conectados nessas barras.
+:::
+
+Abaixo são apresentados os elementos elétricos de potência que podem ser inseridos no PSP-UFU:
+
+![Elementos de potência][powerElements]
+[powerElements]: /PSP/images/powerElements.svg 'Elementos de potência' \ No newline at end of file