Differences

This shows you the differences between two versions of the page.

--- en:tools [2019/02/19 14:20] – fluktuacia
+++ en:tools [2023/02/02 22:39] (current) – update screenshot of design rules. kaklik
@@ Line 1: / Line 1: @@
-FIXME **This page is not fully translated, yet. Please help completing the translation.**\\ //(remove this paragraph once the translation is finished)//
+FIXME **This page is not fully translated, yet. Please help complete the translation.**\\ //(remove this paragraph once the translation is finished)//
 ====== Software tools for MLAB kit development ======
-This site deals with software tools necessary for MLAB kit development and design, for information about technical equipment see  [[en:navody|manuals]].
+This site deals with software tools necessary for MLAB kit development and design, for information about technical equipment, see  [[en:navody|manuals]].
-MLAB design and development is not restricted to one specific set of tools because different users have different demands of and approaches towards different types of sotware.
+MLAB design and development are not restricted to one specific set of tools because different users have different demands and approaches toward different types of software.
 ===== Electronic CADs =====
@@ Line 17: / Line 17: @@
 === Ubuntu installation ===
-There are two options for KiCAD installation in linux - usually it is advised to use the PPA.
+There are two options for KiCAD installation in Linux - usually, it is advised to use the PPA.
 == PPA Repository ==
-[[https://en.wikipedia.org/wiki/Personal_Package_Archive|PPA]] is a system of remote access to an already prepared software packages. They usually contain a more actual version than the packages available from the standard system repositories.
+[[https://en.wikipedia.org/wiki/Personal_Package_Archive|PPA]] is a system of remote access to an already prepared software package. They usually contain a more actual version than the packages available from the standard system repositories.
-In order to download and install the most stable KiCAD version, enter following commands into a terminal:
+In order to download and install the most stable KiCAD version, enter the following commands into a terminal:
   sudo add-apt-repository --yes ppa:js-reynaud/ppa-kicad
@@ Line 49: / Line 49: @@
 == Libraries ==
-  * Standard libraries included directly in the programm [[https://github.com/KiCad|KiCAD]]
+  * Standard libraries included directly in the program [[https://github.com/KiCad|KiCAD]]
-  * [[https://github.com/MLAB-project/kicad-library|Libraries with components specific for MLAB]], which also contain a script for their download from Github and offline work in KiCAD.
+  * [[https://github.com/MLAB-project/kicad-library|Libraries with components specific for MLAB]], which also contain a script for their download from GitHub and offline work in KiCAD.
-It is convenient to use as many parts of MLAB libraries (available at [[https://github.com/MLAB-project/kicad-mlab|GitHubu]]) as possible when designing modules. MLAB libraries contain technologically optimised variants of general encasements, which is important especially during fitting and automatic generation of documentation.
+It is convenient to use as many parts of MLAB libraries (available at [[https://github.com/MLAB-project/kicad-mlab|GitHubu]]) as possible when designing modules. MLAB libraries contain technologically optimized variants of general encasements, which is important, especially during the fitting and automatic generation of documentation.
 Libraries are added to KiCAD separately during schematics drawing and separately during PCB designing - the procedure is very similar in both cases.
@@ Line 70: / Line 70: @@
    UST_ID
-In case that a schematic contains variants of fitted components, the MFPN (?? Identifikace pole) has an additional serial number, for example “MFPN_1”, “MFPN_2” etc. Components with the same serial number belong to the same variant and components without a serial number are common to all fitted variants.
+In case a schematic contains variants of fitted components, the MFPN (?? Identifikace pole) has an additional serial number, for example, “MFPN_1”, “MFPN_2” etc. Components with the same serial number belong to the same variant and components without a serial number are common to all fitted variants.
-When using a following procedure, it is no longer necessary to manually create all fields for every individual component.
+When using the following procedure, it is no longer necessary to manually create all fields for every individual component.
 V menu ''Preferences >> General options >> Field Name Templates''
@@ Line 98: / Line 98: @@
 === Rules for design ===
-Before the beginning of PCB design, it is necessary to set up following rules.
+Before the beginning of PCB design, it is necessary to set up the following rules.
-If you are not using circuits with small pitch of pins, following parameters are good to follow:
+If you are not using circuits with a small pitch of pins, the following parameters are good to follow:
-{{ :cs:navrh_prav.jpg?600 |}}
+{{ en:kicad:kicad_design_rules.png?600 |}}
-{{ :cs:navrh_prav01.jpg?600 |}}
 === Layers ===
@@ Line 566: / Line 565: @@
 == Downloading the current version ==
-  - In the folder (?? Na místě) with the saved repository, run the following command in the command line:
+  - In the folder with the saved repository, run the following command in the command line:
   git pull
@@ Line 644: / Line 643: @@
 === LaTeX ===
-LaTeX je  je systém pro sazbu profesionálních dokumentů. V složce templates je pro něj šablona.
+LaTeX is a document preparation system with typesetting program for formatting its output. There is a template for LaTeX in templates folder.
+When writing documentation in Ubuntu, following packages are used:
-V případě psaní dokumentace v Ubuntu se použivají následující balíky
+  sudo apt-get install texmaker texlive-lang-czechslovak
-  sudo apt-get install texmaker texlive-lang-czechslovak
+After their installation it is possible to write and edit MLAB documents written in [[http://cs.wikipedia.org/wiki/LaTeX|LaTeXu]]
-Po jejich istalaci je možné psát a editovat MLAB dokumenty napsané v [[http://cs.wikipedia.org/wiki/LaTeX|LaTeXu]]
-=== Dokuwiki a Latex ===
+=== Dokuwiki and Latex ===
-Poslední dobou je poměrně častým dokumentačním problémem převod dokumentace postupně vznikající na wiki do formální podoby dokumentu. Přímé přepisování není příliš efektivní. Proto je vhodnější využít programové nástroje jako například [[http://johnmacfarlane.net/pandoc/try/|Pandoc]], ten umí vzájemně převádět mnoho formátů dokumentů. Ale neumí přímý převod Dokuwiki syntaxe na Latex. Lze si však pomoci použitím HTML kódu, který generuje dokuwiki a se kterým již Pandoc umí pracovat.
+Lately, a quite common documentation problem that occurs is a conversion of documentation that is being added on wiki to a formal type of documents. Direct rewriting is not very efficient. It is better to use software tools such as [[http://johnmacfarlane.net/pandoc/try/|Pandoc]], which is able to interconvert a variety of document formats. However, it is not able to directly convert Dokuwiki syntax into LaTeX. It is possible to use HTML code, generated by Dokuwiki that the Pandoc is able to work with.
-Webová verze Pandoc umí zpracovat HTML kód o délce pouze do 1000 znaků. Je proto vhodné si nainstalovat lokální offline verzi.
+A web version of Pandoc can process an HTML code with length only up to 1000 characters. Therefore, it is more usable to install a local offline version.
   sudo apt-get install pandoc
-Převod pak můžeme realizovat příkazem:
+The conversion itself can be run with a following command:
   pandoc -f html -s -t latex temp_doc.html
-Převedený dokument se nám pak vypíše do příkazové řádky, odkud jej pak stačí zkopírovat do Latexového editoru.
+Converted document will be printed into the command line, from which it can be simply copied into a Latex editor.
+[[http://donaldmerand.com/code/2012/07/20/how-i-actually-convert-dokuwiki-to-latex.html| Offline method of conversion]]
-[[http://donaldmerand.com/code/2012/07/20/how-i-actually-convert-dokuwiki-to-latex.html| Offline metoda tohoto převodu]]
+==== Image documentation ====
-==== Obrázková dokumentace ====
 === Dia ===
-Program dia slouží na tvorbu diagramů a blokových schémat.
+A Did software can create diagrams and block diagrams.
 === Fritzing ===
-Je snaha použít fritzing pro tvorbu dokumentace zapojení jednotlivých modulů v konstrukcích. Zatím však Fritzing nepodporuje mechanické umístění. Plošných spojů. Takže se tento nástroj reálně nepoužívá.
+There are efforts to use Fritzing to create a documentation of connections (?? Zapojení) of individual modules in constructions. However, so far it does not support a mechanical placement of PCBs. That is why this tool is not widely used.
 === Prezi ===
-Je nástroj na tvorbu veřejných prezentací projektů.
+A tool for creating a public presentations of projects.
 === ImageMagick  ===
-[[http://www.imagemagick.org/Usage/resize/#shrink|Změna velikosti obrázků]].
+[[http://www.imagemagick.org/Usage/resize/#shrink|Changing the size of images]].
-===== Kontrola kvality =====
+===== Quality control =====
-Pro zkontrolování celkové kvality dokumentace návrhů slouží [[https://www.mlab.cz/modules/all|přehled dokumentace modulů]].
+To control the overall quality of design documentation, you can use [[https://www.mlab.cz/modules/all|an overview of modules' documentation]].
-Tento přehled lze řadit podle různých kriterií. Například
+The overview can be sorted according to different criteria, e.g.:
-  * https://www.mlab.cz/modules/all?order=status,name - řazení podle stavu a jména
+  * https://www.mlab.cz/modules/all?order=status,name - according to status and name
-  * https://www.mlab.cz/modules/all?order=id - podle id (výchozí)
+  * https://www.mlab.cz/modules/all?order=id - according to id (default)
-  * https://www.mlab.cz/modules/all?order=root - podle složky (tedy kategorií)
+  * https://www.mlab.cz/modules/all?order=root - according to folder (and thus categories)
-Každý modul má přiřazenou známku kvality. Aktuálně se hodnotí kvalita fotografie podle následujících kritérií
+Every module has a quality mark assigned. Currently, a quality of photography is rated according to following criteria:
-  * 0 - žádná fotografie
+  * 0 - no photo
-  * 25 - render z KiCAD
+  * 25 - render from KiCAD
-  * 50 - nekvalitní fotografie např. z telefonu
+  * 50 - photo of low quality - e.g. taken on mobile phone
-  * 100 - profesionální fotografie z [[cs:designs:fotobedna|fotografického boxu]].
+  * 100 - a professional photo taken using a [[cs:designs:fotobedna|photo box]].
-===== Organizace vývoje =====
+===== Organisation of development =====
 ==== Redmine ====
-Je nástroj pro vytváření úkolů a dělbu práce na projektech. Jeho instance[[http://www.mlab.cz/redmine|běží na serveru]].
+A tool for creating tasks and division of labour on projects. Its instance [[http://www.mlab.cz/redmine|runs on the server]].
-====== Nástroje pro zpracování dat ======
+====== Tools for data processing ======
-===== Interaktivní výpočetní nástroje =====
+===== Interactive computational tools =====
 ==== Jupyter notebook ====
-Jupyter je softwarový nástroj, který umožňuje použít více výpočetních a programátorských balíků jako je například Python nebo Octave. Výhodou Jupyteru je interaktivní zpracování příkazů což oceníme hlavně při testování nebo psaní nových algoritmů.
+Jupyter is a software tool that enables a use of computational and programming packages such as Python or Octave. Its advantage is an interactive command processing, useful especially during testing or writing of new algorithms.
-=== Instalace ===
+=== Intallation ===
-Postupujeme podle doporučení [[https://github.com/jupyter/notebook|v repozitáři se zdrojovými kódy]].
+Proceed according to recommendations in [[https://github.com/jupyter/notebook|source code repository]].
   sudo pip install notebook
-Spuštění se naopak provede
+To run the software
   jupyter notebook
-Kde si pak zvolíme námi použitý kernel.
+Where we chose the kernel.
 ===== gnuradio =====
-[[http://gnuradio.org/|Gnuradio]] je nástroj pro zpracování signálových dat obvykle z SDR přijímačů.
+[[http://gnuradio.org/|Gnuradio]] is a tool for signal data processing, mostly from SDR receivers.
+====== Simulation tools ======
-====== Simulační nástroje ======
 =====  Nec2++ =====
-[[http://elec.otago.ac.nz/w/index.php/Necpp|Necpp]] je nástroje pro numerické výpočty anténních parametrů.
+[[http://elec.otago.ac.nz/w/index.php/Necpp|Necpp]] is a tool for numerical calculations of antenna parameters.
 ==== QAntenna ====
@@ Line 751: / Line 746: @@
 [[http://qantenna.sourceforge.net/download.php|QAntenna]]
-=== Kompilace ===
+=== Compilation ===
    sudo apt-get install qtbase5-dev qttools5-dev