diff options
Diffstat (limited to 'docusaurus/docs')
| -rw-r--r-- | docusaurus/docs/aboutPSP.md | 40 | ||||
| -rw-r--r-- | docusaurus/docs/cadTools.md | 11 | ||||
| -rw-r--r-- | docusaurus/docs/doc1.md | 200 | ||||
| -rw-r--r-- | docusaurus/docs/doc2.md | 6 | ||||
| -rw-r--r-- | docusaurus/docs/doc3.md | 14 | ||||
| -rw-r--r-- | docusaurus/docs/installation.md | 76 | ||||
| -rw-r--r-- | docusaurus/docs/mainScreen.md | 45 | ||||
| -rw-r--r-- | docusaurus/docs/mdx.md | 17 |
8 files changed, 409 insertions, 0 deletions
diff --git a/docusaurus/docs/aboutPSP.md b/docusaurus/docs/aboutPSP.md new file mode 100644 index 0000000..4535845 --- /dev/null +++ b/docusaurus/docs/aboutPSP.md @@ -0,0 +1,40 @@ +--- +id: aboutPSP +title: PSP-UFU +sidebar_label: PSP-UFU +--- + +:::important +This user guide was written in Brazilian Portuguese. If you want to help me translate this guide, contact-me on [GitHub](https://github.com/Thales1330/PSP/issues) or [Twitter](https://twitter.com/PspUfu). +::: + +## 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 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**. + +O PSP-UFU tem como objetivo fornecer ferramentas eficientes de simulação para fins de **pesquisa** e **educação**, além de **aplicações industriais** em sistemas elétricos de potência. + +Resumidamente, o *software* pode executar os seguintes estudos: + +- Fluxo de potência +- Cálculo de curto-circuito +- Harmônicos +- Estabilidade transitória e dinâmica + +### Artigos publicados e Tese de doutorado +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) + +>Oliveira, T. L., Guimarães, G. C., Silva, L. R., & Rezende, J. O. (2019). Power system education and research applications using free and open-source, graphical and multiplatform PSP-UFU software. *The International Journal of Electrical Engineering & Education*, 0020720919879058. doi: [10.1177/0020720919879058](https://doi.org/10.1177/0020720919879058) + +A Tese de Doutorado abaixo detalha em profundidade os cálculos envolvidos, arquitetura de software e ferramentas implementadas no PSP-UFU: +>Oliveira, T. L. (2019). Desenvolvimento de um programa computacional livre, gráfico, e multiplataforma para analisar sistemas elétricos de potência em regime permanente e dinâmico. doi: [10.14393/ufu.te.2019.2444](https://dx.doi.org/10.14393/ufu.te.2019.2444) + +### Contribuindo com o projeto +Se você está interessado em contribuir com o PSP-UFU de alguma forma (desenvolvimento, críticas, sugestões, etc.), entre em contato pelo [GitHub](https://github.com/Thales1330/PSP/issues) ou [Twitter](https://twitter.com/PspUfu). + +### Desenvolvedor~~es~~ +[Thales Lima Oliveira](https://github.com/Thales1330) + diff --git a/docusaurus/docs/cadTools.md b/docusaurus/docs/cadTools.md new file mode 100644 index 0000000..a66d0f2 --- /dev/null +++ b/docusaurus/docs/cadTools.md @@ -0,0 +1,11 @@ +--- +id: cadTools +title: Ferramentas CAD +sidebar_label: Ferramentas CAD +--- + + +### Zoom +<video autoPlay loop muted controls> + <source src= "/PSP/videos/zoom.mp4" type="video/mp4" /> +</video> diff --git a/docusaurus/docs/doc1.md b/docusaurus/docs/doc1.md new file mode 100644 index 0000000..69bc295 --- /dev/null +++ b/docusaurus/docs/doc1.md @@ -0,0 +1,200 @@ +--- +id: doc1 +title: Style Guide +sidebar_label: Style Guide +--- + +You can write content using [GitHub-flavored Markdown syntax](https://github.github.com/gfm/). + +## Markdown Syntax + +To serve as an example page when styling markdown based Docusaurus sites. + +## Headers + +# H1 - Create the best documentation + +## H2 - Create the best documentation + +### H3 - Create the best documentation + +#### H4 - Create the best documentation + +##### H5 - Create the best documentation + +###### H6 - Create the best documentation + +--- + +## Emphasis + +Emphasis, aka italics, with *asterisks* or _underscores_. + +Strong emphasis, aka bold, with **asterisks** or __underscores__. + +Combined emphasis with **asterisks and _underscores_**. + +Strikethrough uses two tildes. ~~Scratch this.~~ + +--- + +## Lists + +1. First ordered list item +1. Another item + - Unordered sub-list. +1. Actual numbers don't matter, just that it's a number + 1. Ordered sub-list +1. And another item. + +* Unordered list can use asterisks + +- Or minuses + ++ Or pluses + +--- + +## Links + +[I'm an inline-style link](https://www.google.com/) + +[I'm an inline-style link with title](https://www.google.com/ "Google's Homepage") + +[I'm a reference-style link][arbitrary case-insensitive reference text] + +[I'm a relative reference to a repository file](../blob/master/LICENSE) + +[You can use numbers for reference-style link definitions][1] + +Or leave it empty and use the [link text itself]. + +URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com/ or <http://www.example.com/> and sometimes example.com (but not on GitHub, for example). + +Some text to show that the reference links can follow later. + +[arbitrary case-insensitive reference text]: https://www.mozilla.org/ +[1]: http://slashdot.org/ +[link text itself]: http://www.reddit.com/ + +--- + +## Images + +Here's our logo (hover to see the title text): + +Inline-style:  + +Reference-style: ![alt text][logo] + +[logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png 'Logo Title Text 2' + +--- + +## Code + +```javascript +var s = 'JavaScript syntax highlighting'; +alert(s); +``` + +```python +s = "Python syntax highlighting" +print(s) +``` + +``` +No language indicated, so no syntax highlighting. +But let's throw in a <b>tag</b>. +``` + +```js {2} +function highlightMe() { + console.log('This line can be highlighted!'); +} +``` + +--- + +## Tables + +Colons can be used to align columns. + +| Tables | Are | Cool | +| ------------- | :-----------: | -----: | +| col 3 is | right-aligned | \$1600 | +| col 2 is | centered | \$12 | +| zebra stripes | are neat | \$1 | + +There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. + +| Markdown | Less | Pretty | +| -------- | --------- | ---------- | +| _Still_ | `renders` | **nicely** | +| 1 | 2 | 3 | + +--- + +## Blockquotes + +> Blockquotes are very handy in email to emulate reply text. This line is part of the same quote. + +Quote break. + +> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can _put_ **Markdown** into a blockquote. + +--- + +## Inline HTML + +<dl> + <dt>Definition list</dt> + <dd>Is something people use sometimes.</dd> + + <dt>Markdown in HTML</dt> + <dd>Does *not* work **very** well. Use HTML <em>tags</em>.</dd> +</dl> + +--- + +## Line Breaks + +Here's a line for us to start with. + +This line is separated from the one above by two newlines, so it will be a _separate paragraph_. + +This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the _same paragraph_. + +--- + +## Admonitions + +:::note + +This is a note + +::: + +:::tip + +This is a tip + +::: + +:::important + +This is important + +::: + +:::caution + +This is a caution + +::: + +:::warning + +This is a warning + +::: diff --git a/docusaurus/docs/doc2.md b/docusaurus/docs/doc2.md new file mode 100644 index 0000000..16cfce4 --- /dev/null +++ b/docusaurus/docs/doc2.md @@ -0,0 +1,6 @@ +--- +id: doc2 +title: Document Number 2 +--- + +This is a link to [another document.](doc3.md) This is a link to an [external page.](http://www.example.com/) diff --git a/docusaurus/docs/doc3.md b/docusaurus/docs/doc3.md new file mode 100644 index 0000000..2c40cc6 --- /dev/null +++ b/docusaurus/docs/doc3.md @@ -0,0 +1,14 @@ +--- +id: doc3 +title: This is Document Number 3 +--- + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. In ac euismod odio, eu consequat dui. Nullam molestie consectetur risus id imperdiet. Proin sodales ornare turpis, non mollis massa ultricies id. Nam at nibh scelerisque, feugiat ante non, dapibus tortor. Vivamus volutpat diam quis tellus elementum bibendum. Praesent semper gravida velit quis aliquam. Etiam in cursus neque. Nam lectus ligula, malesuada et mauris a, bibendum faucibus mi. Phasellus ut interdum felis. Phasellus in odio pulvinar, porttitor urna eget, fringilla lectus. Aliquam sollicitudin est eros. Mauris consectetur quam vitae mauris interdum hendrerit. Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +Duis et egestas libero, imperdiet faucibus ipsum. Sed posuere eget urna vel feugiat. Vivamus a arcu sagittis, fermentum urna dapibus, congue lectus. Fusce vulputate porttitor nisl, ac cursus elit volutpat vitae. Nullam vitae ipsum egestas, convallis quam non, porta nibh. Morbi gravida erat nec neque bibendum, eu pellentesque velit posuere. Fusce aliquam erat eu massa eleifend tristique. + +Sed consequat sollicitudin ipsum eget tempus. Integer a aliquet velit. In justo nibh, pellentesque non suscipit eget, gravida vel lacus. Donec odio ante, malesuada in massa quis, pharetra tristique ligula. Donec eros est, tristique eget finibus quis, semper non nisl. Vivamus et elit nec enim ornare placerat. Sed posuere odio a elit cursus sagittis. + +Phasellus feugiat purus eu tortor ultrices finibus. Ut libero nibh, lobortis et libero nec, dapibus posuere eros. Sed sagittis euismod justo at consectetur. Nulla finibus libero placerat, cursus sapien at, eleifend ligula. Vivamus elit nisl, hendrerit ac nibh eu, ultrices tempus dui. Nam tellus neque, commodo non rhoncus eu, gravida in risus. Nullam id iaculis tortor. + +Nullam at odio in sem varius tempor sit amet vel lorem. Etiam eu hendrerit nisl. Fusce nibh mauris, vulputate sit amet ex vitae, congue rhoncus nisl. Sed eget tellus purus. Nullam tempus commodo erat ut tristique. Cras accumsan massa sit amet justo consequat eleifend. Integer scelerisque vitae tellus id consectetur. diff --git a/docusaurus/docs/installation.md b/docusaurus/docs/installation.md new file mode 100644 index 0000000..0ae22e8 --- /dev/null +++ b/docusaurus/docs/installation.md @@ -0,0 +1,76 @@ +--- +id: installation +title: Instalação +sidebar_label: Instalação +--- +## Download + +O download do PSP-UFU pode ser realizado pelo ["*last release*" do repositório do PSP-UFU no GitHub](https://github.com/Thales1330/PSP/releases/latest). + +Ao acessar ao link, role a página até encontrar os *Assets*: + +![Download][download] +[download]: /PSP/images/download.png 'Assets donwload' + +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*. +- Para os sistemas [Linux](installation#linux) baseados no Debian (por exemplo, Ubuntu, Mint) *64 bits* baixe o pacote de instalação *.deb*. + +:::tip Dica +Se você está interessado em contribuir com o PSP-UFU construindo-o para outros sistemas operacionais (principalmente macOS!) entre em contato pelo [GitHub](https://github.com/Thales1330/PSP/issues) ou [Twitter](https://twitter.com/PspUfu). +::: + +Na sequência são apresentados o passo-a-passo para instalação dos SOs [Windows](installation#windows) e [Linux](installation#linux). Também são apresentadas as soluções para os erros mais recorrentes. + +## Windows +Após baixar o arquivo *.exe* avance em cada passo do instalador. O executável irá solicitar automaticamente a instalação do **Microsoft Visual C++ Redistribuível** e, caso não esteja instalado no seu computador, realize os procedimentos do programa. + +Caso o executável falhe em abrir, baixe o arquivo *.zip* e descompacte em alguma pasta do seu sistema. Nesse caso é necessário baixar e instalar manualmente o [**Microsoft Visual C++ Redistribuível 32 bits**](https://aka.ms/vs/16/release/vc_redist.x86.exe). + +Após a conclusão da instalação abra o PSP-UFU para verificar a correta instalação. O executável está presente na pasta "*<local de instalação>/PSP-UFU/bin/PSP-UFU.exe*". + +### Problemas recorrentes no Windows +- Ao baixar o navegador pode **falsamente** sinalizar que é um arquivo perigoso, basta clicar em "Manter arquivo"; +- Ao abrir o instalador, novamente o Windows sinaliza que o arquivo é perigoso, basta clicar em "Executar assim mesmo"; +- Ao abrir o programa e alterar o seu idioma, uma mensagem de erro é exibida. Para resolver esse problema basta executar o PSP-UFU como administrador (clicar com botão direito no atalho do programa e posteriormente em executar como administrador). Altere novamente o idioma e reinicie o programa; +- Ao criar um novo projeto a tela de trabalho não é exibida ou é exibida uma tela preta. Vá nas opções gerais e altere o renderizador para "Device Context". Caso apareça uma mensagem de erro, execute o programa como administrador e repita o processo. Reinicie o programa. + + +## Linux +A instalação no sistema Linux é facilmente realizado pelo pacote de instalação automático *.deb*. +:::caution Atenção! +Note que essa versão para Linux está defasada e algumas funcionalidades do programa podem não estar presentes. + +Caso queira contribuir com o projeto e construir a versão atual no sistema Linux baseado em Debian ou em outras distribuições entre em contato pelo [GitHub](https://github.com/Thales1330/PSP/issues) ou [Twitter](https://twitter.com/PspUfu). +::: + +### Problemas recorrentes no Linux +Pode ser necessário adicionar o [diretório das bibliotecas do wxWidgets](https://wiki.wxwidgets.org/Compiling_and_getting_started#Running_wxWidgets_projects) nas variáveis de ambiente. +Para isso, siga **UM** dos métodos apresentados abaixo: + +#### *Método I (recomendado)* +Insira o seguinte comando no arquivo **~/.bashrc**: +```shell +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. +::: +1. Abra o terminal e acesse o diretório onde está instalado o PSP-UFU: +```shell +cd /usr/local/bin +``` +2. Insira as bibliotecas compartilhadas do wxWidgets nas variáveis de ambiente: +```shell +export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib +``` +3. Então, execute o PSP-UFU na **mesma seção** do terminal: +```shell +./PSP-UFU +``` + +:::caution Atenção! +Verifique se o computador possui as unidades de vídeo instaladas corretamente, caso contrário, o programa não exibirá a área de trabalho para criar e editar diagramas de linha única ou diagramas de blocos de controle. +::: diff --git a/docusaurus/docs/mainScreen.md b/docusaurus/docs/mainScreen.md new file mode 100644 index 0000000..dd5c9f0 --- /dev/null +++ b/docusaurus/docs/mainScreen.md @@ -0,0 +1,45 @@ +--- +id: mainScreen +title: Tela Principal +sidebar_label: Tela Principal +--- +## Organização da tela principal +A tela principal do PSP-UFU é dividida em três seções: *[Menu "Ribbon"](mainScreen#menu-ribbon)*, *[Área de Trabalho](mainScreen#área-de-trabalho)* e *[Barra de Status](mainScreen#barra-de-status)*. + +![Tela Principal][mainScreen] +[mainScreen]: /PSP/images/mainScreen.svg 'Tela principal do PSP-UFU no Windows' + +Resumidamente, no **Menu Ribbon** são acessadas as ferramentas do PSP-UFU; na **Área de Trabalho** são criados os diagramas unifilares de potência; e na **Barra de Status** são exibidas importantes informações acerca do estado da Área de Trabalho. + + +### Menu Ribbon +>Em informática o ribbon (faixa, em inglês) é um formato de apresentação de interface baseada na GUI onde a barra de ferramentas é mostrada através de uma barra mais larga com icones maiores possibilitando o uso dos aplicativos por dispositivos *touch screen*. +[Wikipedia](https://pt.wikipedia.org/wiki/Ribbon_(inform%C3%A1tica)) + +O menu Ribbon é composto de três submenus: “Arquivo”, “Ferramentas” e “Simulação”. + +Em **Arquivo** estão as ferramentas gerais do programa, as quais permitem ao usuário criar e salvar novos projetos, além daquelas que possibilitam carregar os projetos já existentes e importar arquivos de outros programas. Esse submenu também possui opções gerais do programa e acesso a informações sobre o programa. + +![Menu Arquivo][menuFile] +[menuFile]: /PSP/images/menuFile.png 'Menu Arquivo' + +Em **Ferramentas** estão presentes os itens específicos, os quais estão relacionados à criação e manipulação da rede elétrica de potência, relatórios tabulares de saída de dados e acesso ao formulário de criação de gráficos no tempo. Algumas configurações específicas do projeto ativo são acessadas por esse menu. + +![Menu Ferramentas][menuTools] +[menuTools]: /PSP/images/menuTools.png 'Menu Ferramentas' + +Finalmente, o submenu **Simulação** proporciona o acesso do usuário aos cálculos realizados pelo *software* e suas configurações, além da ferramenta de “solução contínua”, a qual resolve os cálculos estáticos (fluxo de potência, curto-circuito e harmônicos) após quaisquer mudanças na rede de potência, como remoção de componente ou alteração de seus dados. Todas as configurações de simulação do projeto ativo são acessadas por esse menu. + +![Menu Simulation][menuSimulation] +[menuSimulation]: /PSP/images/menuSimulation.png 'Menu Simulação' + +### Área de Trabalho +Na área de trabalho estão presentes os projetos em execução, os quais são divididos por abas identificadas pelo nome do projeto (caso já esteja gravado no disco). É nessa área que são inseridos e excluídos os elementos elétricos, cujas ferramentas são acessadas por meio do [Menu Ribbon](mainScreen#menu-ribbon). + +As edições gráficas dos elementos, como posição, conexão e tamanho dos barramentos, são realizadas por meio da ação *drag-and-drop* (arrastar e soltar) com a utilização do mouse. A edição dos dados elétricos é feita por meio de formulários de dados acessados clicando duas vezes sobre os elementos. + +![Área de Trabalho][workspace] +[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 diff --git a/docusaurus/docs/mdx.md b/docusaurus/docs/mdx.md new file mode 100644 index 0000000..f0210fb --- /dev/null +++ b/docusaurus/docs/mdx.md @@ -0,0 +1,17 @@ +--- +id: mdx +title: Powered by MDX +--- + +You can write JSX and use React components within your Markdown thanks to [MDX](https://mdxjs.com/). + +export const Highlight = ({children, color}) => ( <span style={{ + backgroundColor: color, + borderRadius: '2px', + color: '#fff', + padding: '0.2rem', + }}>{children}</span> ); + +<Highlight color="#25c2a0">Docusaurus green</Highlight> and <Highlight color="#1877F2">Facebook blue</Highlight> are my favorite colors. + +I can write **Markdown** alongside my _JSX_! |