User Tools

Site Tools


en:tools

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:tools [2019/02/13 16:28]
fluktuacia
en:tools [2019/03/18 23:34] (current)
fluktuacia [Linux]
Line 244: Line 244:
 == Generating netlists == == Generating netlists ==
  
- +Netlist ​contains ​list of connections in PCB design, values of components and names of their encasementsIt can be generated via a Tools / Create Netlist ​option. ​
-Netlist ​obsahuje seznam spojů pro návrh plošného spoje, hodnoty součástek ​názvy jejich pouzderGneruje se volbou ​Tools / Create Netlist+
  
 Other Other
 PCB Footprint / Combined Property String = {Device},​{Value}@{PCB Footprint} PCB Footprint / Combined Property String = {Device},​{Value}@{PCB Footprint}
 Formatters = padspcb.dll Formatters = padspcb.dll
-Netlist File 1 – nastavit příponu ​.ASC +Netlist File 1 – set a suffix ​.ASC 
-Generování seznamu součástí+Generating list of components
  
-Tvorba seznamu součástí se skládá ze dvou kroků+Creating a list of components consists of two steps
  
-      - Vygenerování seznamu ze schématu +      - Generating a list from a schematics 
-      - Úprava do podoby ​XLS tabulky ​+      - Conversion into an XLS table
  
-Seznam součástí se z OrCADu vygeneruje funkcí ​Bill of Material a výsledkem je TXT soubor.+A list of components from OrCADS is generated using a Bill of Material ​function, resulting in a TXT file.
  
 Header: Quantity\tReference\tPart\tPCB Footprint Header: Quantity\tReference\tPart\tPCB Footprint
 Combined property string: {Quantity}\t{Reference}\t{Value}\t{PCB Footprint} Combined property string: {Quantity}\t{Reference}\t{Value}\t{PCB Footprint}
  
-Finální podoba seznamu součástí je XLS tabulkaVzor tabulky je v souboru ​VZOR_Seznam_součástí.xls. ​Vzor uložíme do adresáře ​SCH a otevřeme jejDále postupujeme podle návodu ve vzoru napsanému+The final form of components’ list is an XLS tableYou can find an exemplar of table in VZOR_Seznam_součástí.xls. ​Save it into the SCH directory and open itProceed according to the instructions that are found in the exemplar.  
-Generování ​.PDF+Generating ​.PDF 
 + 
 +Printing usually uses A4 as its target format, even in case of schematics that are originally of A3 size. 600dpi resolution is sufficient for a good quality output.
  
-Tisk provádíme obvykle na cílový formát A4 a to i pro schémata originálního formátu A3Pro kvalitní výstup stačí rozlišení 600dpi.+File is named according ​to the name of the module with a _sch suffix - e.g. SAMPLE_sch.pdf.
  
-Soubor se jmenuje jako jméno modulu s doplňkem _sch. Například POKUS_sch.pdf. +Adobe Acrobat Distiller - preferred
-Adobe Acrobat Distiller - preferované+
  
-Acrobat Distiller ​dává barevné ​PDF souboryŽádné specifické nastavení parametrů Acrobat Distiller nepotřebuje ​(600dpi, ​měřítko ​100%).+Acrobat Distiller ​creates colourful ​PDF filesIt does not need any specific parameter setting ​(600dpi, ​scale 100%).
  
-Při tisku z programu ​OrCAD Capture ​je třeba nastavit zmenšení ​posunutí tisku aby byly rozumné okraje takto:+When printing with OrCAD Capture, it is necessary to set up reduction in scale of the print and its shift in order for borders to be satisfactory. ​
  
-Schéma ​A3 – Scale=0,65; Print Offset X=12, Y=10 +A3 schematics ​– Scale=0,65; Print Offset X=12, Y=10 
-Schéma ​A4 – Scale=0,91; Print Offset X=12, Y=10+A4 schematics ​– Scale=0,91; Print Offset X=12, Y=10
 Adobe Acrobat Writter Adobe Acrobat Writter
  
-Acrobat Writter ​dává černobílé PDFPro dosažení malé velikosti výsledných ​PDF souborů je třeba nastavit komprimaciVelikost výstupu ani posunutí nejde ovlivnitVýhodou je tože schéma může být tisknuto najednou i když obsahuje listy různých formátůCílovým formátem nemusí být nutně formát A4 ale je to nejobvyklejšíRůzné verze programu mají různé možnosti nastavení.+Acrobat Writter ​create black and white PDFsIn order to get a small size of the final PDF files, a compression has to be setNeither the output size nor the shift cannot be alteredAdvantage of this program isthat the schematics can be printed at once even if it contains lists in various formatsThe final format does not have to be A4, however it is the most common caseDifferent versions of the program have different settings’ possibilities
  
 Page Setup Page Setup
Line 288: Line 288:
 General / Compress text and lineart = Yes General / Compress text and lineart = Yes
 Color/Gray Scale Images / Compress using = ZIP Color/Gray Scale Images / Compress using = ZIP
-Úklid souborů 
  
-Smažeme nepotřebné soubory, u cílových souborů zkontrolujeme jména souborů a nastavíme Read Only atribut.+Files cleanup
  
-Následující soubory se obvykle nezavádějí do databáze:+Delete all the unnecessary files, check the names of the final files and set Read Only attribute. ​
  
-    * .OPJ definice projektu +The following files are not routinely loaded ​(?? Zavéstto database:
-    * .DBK záložní soubor schématu ​(.DSN) +
-    * .OBK záložní soubor knihovny (.OLB)+
  
-Naopak následující soubory obsahují podstatná data:+    * .OPJ project definitions 
 +    * .DBK backup schematics file (.DSN) 
 +    * .OBK backup library file (.OLB)
  
-    * .DSN soubor schématu (obsahuje i library cache použitých knihovních prvků) +On the contrary, the following files do contain important data:
-    * .OLB soubor knihovny (společné knihovny nejlépe v adresáři C:\LIBRARY\ORCAD9x) +
-    * .ASC soubor spojů – netlist +
-    * .PDF soubor s vytištěným schématem (název ve tvaru XXX_sch.pdf) +
-    * .XLS soubor se seznamem součástí včetně objednacích informací+
  
-Povinné úkony+    * .DSN schematics file (also contains library cache of the used elements of libraries) 
 +    * .OLB library file (common libraries, best when in C:​\LIBRARY\ORCAD9x directory) 
 +    * .ASC netlist 
 +    * .PDF file with the printed schematics (name in the XXX_sch.pdf format) 
 +    * .XLS file with the components’ list, including ordering (??) objednacích information
  
-Seznam povinných úkonů slouží pro rychlé ověření, že se na nic důležitého nezapomnělo. Na všechny otázky by se mělo odpovědět buď „ano“ nebo „v tomto případě záměrně ne“.+Mandatory actions
  
-Založení nového schématu:+The list of mandatory actions serves as a quick check that you have not forgotten anything important. All the question should be answered either “yes” or “in this case intentionally no”. ​
  
-    * Je zvolen správný formát listů (A4 nebo A3) ? +New schematics establishment:​
-    * Je na první straně informace o historii schématu ? +
-    * Jsou hodnoty neosazovaných součástek označeny podtržítkem ? +
-    * Jsou na schématu i součástky,​ které se neosazují na plošný spoj ? +
-    * Jsou na schématu alespoň 2 fidu značky na každou stranu plošného spoje ?+
  
-Aktualizace:​+    * Is the right page format chosen (A4 or A3) ? 
 +    * Is there an information about the schematics history on the first page?  
 +    * Are the values of the components that will not be mounted marked by an underscore?​ 
 +    * Does the schematics contain also componontents that will not be mounted onte the PCB 
 +    * Are there at least 2 fidu marks (??) for each PCB side on every schematics? ​
  
-    ​Je historie na první stránce aktuální ​+Actualisations:​ 
-    * Je rohové razítko na všech stranách aktuální ​+ 
-    * Je vygenerovaný platný ​netlist ​.ASC souboru ​+    ​Is the history on the first page up-to-date
-    * Je vygenerovaný tiskový soubor schématu v .PDF souboru ​+    * Is the title block on every page up-to-date
-    * Je správné pořadí stránek v .PDF souboru ​+    * Have you generated a valid netlist ​in .ASC format
-    * Je vygenerovaný seznam součástek ​+    * Have you generated schematics print file in .PDF format
-    * Mají soubory správný název ​+    * Is there a correct page order in the .PDF file
-    * Mají soubory atribut ​Read Only ? +    * Have you generated a list of components
-    * Jsou smazané nepotřebné soubory ​(i adresáře) ?+    * Are the files named correctly
 +    * Do the files have Read Only attribute set
 +    * Have you deleted any unnecessary files (and directories)?
  
  
 ==== Eagle ==== ==== Eagle ====
  
-Některé moduly jsou navržené v tomto systému ale díky nutnosti odlišné adresářové struktury jsou publikovány v SVN databázi ​MLAB_E, která zatím nemá webové výpisyDo budoucna se využití ​Eagle pro návrh modulů dále nepředpokládá.+Some modules are designed in this system - however, due to a necessity of having different directory structure, they are published in SVN database ​MLAB_E ​that does not yet have web listingsIn the future, we do not expect further using Eagle for module design.
  
-=== Texty a popisy ​===+=== Texts and labels ​===
  
-Program ​Eagle používá jiné textové fonty než původně využívaný program ​PADs, proto je nastavení mírně odlišnézatím se jako nejlepší jeví toto+Eagle software uses different text fonts that a formerly used PADs, that is why its setting is slightly different. So farthe following setting seems to work best:
  
-  * Vrstva mědi popisky ​font "​Vector",​ Size 80, Ratio 10%.+  * Copper layer labels ​font "​Vector",​ Size 80, Ratio 10%.
  
-Na jednom modulu se může vyskytovat více velikostí písma, ​(obvykle na modulech stačí méně, než 3). Pouzivaji se v poradinazev modulupopiskyvýstrahyoznačení autoraRůzné velikosti se samozřejmě používají pouze v případechkdy je k tomu na modulu místo. Na některých ​ modulech je proto jenom jedna velikost písma podřízená čitelnosti ​rozměrům modulu   +One module can contain more font sizes (usually less than is enough). They are used in the following order: module namelabelswarningsauthor identification. Different font sizes are of course only used in caseswhen there is enough space on the moduleThereforesome modules only contain one font size, with respect to good readability and module size
  
  
-===== Mechanické CADy =====+===== Mechanical CADs =====
  
 ==== LibreCAD ==== ==== LibreCAD ====
  
-Pro kreslení plošných technických výkresů je využíván ​[[http://​librecad.org/​cms/​home.html|LibreCAD]]. ​Ubuntu ​jej lze nainstalovat přímo z balíku:+To draw flat technical drawings ​[[http://​librecad.org/​cms/​home.html|LibreCAD]] ​can be usedIn Ubuntu, it can be installed directly from the package (?? Z balíku):
  
   sudo apt-get install librecad   sudo apt-get install librecad
Line 354: Line 355:
 ==== FreeCAD ==== ==== FreeCAD ====
  
-[[https://​www.freecadweb.org/​|FreeCAD]] ​se naopak hodí pro 3D modelování klasickým způsobemkterý je známý z komerčních ​CAD programůZatím je výhodné používat jeho denní ​build verze dostupné z PPA.+[[https://​www.freecadweb.org/​|FreeCAD]] ​is on the other hand well suited for a classical ​3D modellingknown from many proprietary ​CAD softwareIt seems convenient to use its daily build, available from PPA.
  
   sudo add-apt-repository ppa:​freecad-maintainers/​freecad-daily   sudo add-apt-repository ppa:​freecad-maintainers/​freecad-daily
Line 364: Line 365:
 ==== OpenSCAD ==== ==== OpenSCAD ====
  
-[[http://​www.openscad.org/​|OpenSCAD]] ​je nástroj pro návrh ​3D modelů technických zařízeníNa rozdíl od většiny návrhových nástrojů ​OpenSCAD ​využívá pro popis objektu programovací jazyk. ​ Tento přístup umožňuje jednak parametrizaci modelů ​navíc jejich snadné verzování s identifikací přesné změnyZákladní úvod do používání programu je na [[http://​blog.cubehero.com/​2013/​11/​19/​know-only-10-things-to-be-dangerous-in-openscad/​|Know only 10 things to be dangerous in OpenSCAD]], existuje také [[http://​www.openscad.org/​cheatsheet/​|přehled základních funkcí]]. +[[http://​www.openscad.org/​|OpenSCAD]] ​is a tool for designing ​3D models of technical devicesIn contrast with most of the design tools, ​OpenSCAD ​uses programming language to describe objectsThis approach allows models parametrisation and their easy versioning with an accurate identification of changes. A basic introduction into its using can be found here [[http://​blog.cubehero.com/​2013/​11/​19/​know-only-10-things-to-be-dangerous-in-openscad/​|Know only 10 things to be dangerous in OpenSCAD]]. There is also an [[http://​www.openscad.org/​cheatsheet/​|overview of basic functions]].
  
  
-=== Instalace ​Ubuntu ===+=== Ubuntu ​Installation ​===
  
-Pro instalaci aktuální verze od Ubuntu 14.10 je připraven ​PPA repozitář+In order to instal the actual version for Ubuntu 14.10 and higher, there is a PPA repository ready:
   sudo add-apt-repository ppa:​openscad/​releases   sudo add-apt-repository ppa:​openscad/​releases
   sudo apt-get update   sudo apt-get update
     ​     ​
-Openscad ​můžeme po jeho přidání pak nainstalovat příkazem+Openscad ​can be then installed using a following command
   sudo apt-get install openscad   sudo apt-get install openscad
  
-Spustíme jej pak obvyklým způsobem z dashboardu, nebo z příkazového řádku.+The programme can be opened in the usual from dashboard or using command line.
  
-Pro použití nejnovějších funkcí je vhodné použít denní kompilaci openscadu. ​+For the newest functions to be available use the daily Openscad compilation:​
   sudo apt-get install openscad-nightly   sudo apt-get install openscad-nightly
  
-Tu lze pak spustit z příkazového řádku jako openscad-nightly, ​obě verze proto mohou být naistalované paralelně+It can be run from the command line like openscad-nightly, ​both versions can be installed in parallel.
  
 <WRAP center round tip 80%> <WRAP center round tip 80%>
-Pro zobrazení náhledů vygenerovaných ​STL souborů v prohlížeči ​Nautilus ​můžete využít nástroj ​[[https://​github.com/​MLAB-project/​stl-thumbnailer|stl-thumbnailer]].+To display the STL generated views in Nautilus, you can use [[https://​github.com/​MLAB-project/​stl-thumbnailer|stl-thumbnailer]] ​tool.
 </​WRAP>​ </​WRAP>​
  
-=== Styl psaní kódu (coding ​style===+=== Coding ​style ===
  
-Je praktické dodržovat některá základní pravidla při vytváření modelů v openscadu.+It is practical to follow some basic coding style rules when creating models in opens cad.
  
-  * Názvy proměnných vytvářet v mezinárodním jazyce ​(angličtina a globálně známé výrazy a zkratky)  +  * Use international language for the names of variables ​(English, using globally known expressions and abbreviations)  
-  * Příliš nezkracovat názvy proměnných +  * Do not shorten the names of variables too much 
-  * Proměnné a operátory oddělovat mezerami +  * Separate the variables and operators by spaces 
-  * Používat odsazení o mezery ​(tabulátorve vnořeném bloku kódu+  * Use space indentation ​(tabulatorin a nested code block
  
   ​   ​
-=== Použití editoru ​SublimeText ===+=== Using SublimeText ​editor ​===
  
-Editor integrovaný přímo do OpenSCADu není moc pohodlný pro užíváníJe proto vhodnější zdrojové kódy modelů editovat v editoru ​[[https://​www.sublimetext.com/​|SublimeText 3]].  K tomu je ale vhodné si do editoru nainstalovat ​plugin, který zná jazyk OpenSCADdu+The editor integrated directly into OpenSCAD is not very comfortable for useTherefore we prefer to edit the source codes of models in [[https://​www.sublimetext.com/​|SublimeText 3]] editor - you can install a plugin ​that recognises the OpenSCAD language
  
-Instalaci lze provést přes systém balíčků, který můžeme aktivovat volbou ​//Tools -> Install Package Control..//​. ​+The installation can be done through a system of packages that can be activated via  ​//Tools -> Install Package Control..//​. ​
  
 {{:​cs:​sw:​sublimetext3_package_control_install.png?​400|}} {{:​cs:​sw:​sublimetext3_package_control_install.png?​400|}}
  
-Otevřeme nástroj pro zacházení s balíčky volbou ​//​Preferences -> Package Control//.+Open the package control tool with  ​//​Preferences -> Package Control// ​option
  
 {{:​cs:​sw:​sublimetext3_package_control.png?​400|}} {{:​cs:​sw:​sublimetext3_package_control.png?​400|}}
  
-V nabídce zvolíme ​"​Install Package"​+In the menu choose ​"​Install Package"​
  
 {{:​cs:​sw:​sublimetext3_install_package.png?​400|}} {{:​cs:​sw:​sublimetext3_install_package.png?​400|}}
  
-Do filtračního pole napíšeme "openscad"​. A klikneme na odpovídající balíček.+Write “openscad" ​into a filter field and click the proper package
  
 {{:​cs:​sw:​sublimetext3_install_openscad.png?​400|}} {{:​cs:​sw:​sublimetext3_install_openscad.png?​400|}}
  
-Nyní je potřeba ​SublimeText ​zavřít a znovu otevřít, aby se nová konfigurace projevila+Now it is necessary to close and re-open the SublimeText ​so that the new configuration will be set
-Potom je možné nastavit, aby všechny soubory s příponou ​//​.scad// ​byly otevřeny s OpenSCAD ​zvýrazňováním syntaxeTo lze nastavit přes volbu v pravém dolním rohu a výběrem ​//Open all with current extension as.. -> OpenScad//+Then it is possible change the setting so that all files with //​.scad// ​suffix will be opened with OpenSCAD ​syntax highlightingThis setting can be done via an option found in lower right corner and choosing ​//Open all with current extension as.. -> OpenScad//
  
 {{:​cs:​sw:​sublimetext3_select_openscad.png?​400|}} {{:​cs:​sw:​sublimetext3_select_openscad.png?​400|}}
  
-Při následujícím otevření ​.scad souboru bude automaticky rozpoznán jako OpenSCAD ​zdrojový kód.+During the following opening of any .scad file, it will be automatically recognised as a OpenSCAD ​source file.
  
-===== Generování a prohlížení výrobních dat =====+===== Generating and viewing production data=====
  
-==== Gerber data ====+==== Data gerber ​====
  
-Pro prohlížení vygenerovaných dat jsou vhodné nástroje:+To view the generated data, there are several tools available:
  
   * [[http://​gerbv.sourceforge.net/​|Gerbv]] - Linux   * [[http://​gerbv.sourceforge.net/​|Gerbv]] - Linux
   * [[http://​www.pentalogix.com/​|ViewMate]] - Windows   * [[http://​www.pentalogix.com/​|ViewMate]] - Windows
  
-=== Skládání ​gerber ​dat ===+=== Merging the gerber ​data ===
  
-Pro skládáni dat lze využít program ​gerbmerge. ​Který se na internetu vyskytuje v několika různých větvích vývoje. Pro použití s programem ​kicad je vvýhodné použít relativně novou vývojovou větev ​[[http://​www.dent.med.uni-muenchen.de/​~kkunzelm/​htdocs/​6_software-tools-panelize_metric-kicad-files.html| prof. +In order to merge your data, you can use gerbmerge ​software - there are several different development branches on the InternetWhen you want to use it with kicad software, it is convenient to use a relatively new development branch ​[[http://​www.dent.med.uni-muenchen.de/​~kkunzelm/​htdocs/​6_software-tools-panelize_metric-kicad-files.html| prof. 
- ​Karl-heinz Kunzelmann]]. ​ Ta vychází z prvotní verze 1.8. a dalších úprav. Poměrně významně se však liší od verze [[https://​github.com/​MLAB-project/​gerbmerge3|gerbmerge3]], ​která ale má čistější zdrojový kód + ​Karl-heinz Kunzelmann]]. ​It is base on the first version ​1.8 and other adjustementsIt differs significantly from a [[https://​github.com/​MLAB-project/​gerbmerge3|gerbmerge3]] ​versionwhich on the other hand has a cleaner source code
  
-Nejdříve nainstalujeme závislosti+First, we install dependencies.
   sudo apt-get install python-simpleparse python-simpleparse-mxtexttools   sudo apt-get install python-simpleparse python-simpleparse-mxtexttools
  
-Následně stáhneme ​gerbmerge ​z githubu.+Next, we download ​gerbmerge ​from GitHub.
   git clone https://​github.com/​MLAB-project/​gerbmerge   git clone https://​github.com/​MLAB-project/​gerbmerge
   cd gerbmerge   cd gerbmerge
   sudo python setup.py install   sudo python setup.py install
  
-Aby gerbmerge ​fungovaltak je mu potřeba zadat způsob panelizace ​to se dělá konfiguračním souboremPříklad konfiguračního souboru je vložen u zdrojových kódů programuPřímo v něm jsou komentářvysvětlující jeho použití. +For gerbmerge ​software to function properlyit has to have a set way of paneling (způsob panelizace)This is done via a configuration file - an example of such file can be found in programme source code (it also contains commentaries explaining its usage)If we have a prepared configuration file, e.g. //​layout-mm-3.3.cfg//​, we can run the gerbmerge.
-Pakud ale máme připravený konfigurační soubor např. //​layout-mm-3.3.cfg// ​tak gerbmerge ​můžeme spustit.+
  
   kaklik@popelnice:​~/​git/​gerbmerge/​testdata-with-KiCAD-using-metric-units/​MLAB_panel$ ../​../​src/​gerbmerge/​gerbmerge.py layout-mm-3.3.cfg   kaklik@popelnice:​~/​git/​gerbmerge/​testdata-with-KiCAD-using-metric-units/​MLAB_panel$ ../​../​src/​gerbmerge/​gerbmerge.py layout-mm-3.3.cfg
  
-Program se pokusí nalézt optimální rozložení motivů na panelu podle zvolené konfigurace ​vygeneruje výsledné složené soubory+The programme will try to find an optimal motives’ layout on panel according to chosen configuration and it will generate merged files.
  
-Příklad pro složení ​SET10A (instalace se schoduje s předchozím příkladem+An example for merging ​SET10A (the installation is the same as the previous example). 
-Nejprve je potřeba se dostat do místakde jsou data setu+Firstit is necessary to get to the place with the set data:
   MLAB@MLAB:​~/​MLAB-project/​gerbmerge/​MLAB_panel/​SET10A$   MLAB@MLAB:​~/​MLAB-project/​gerbmerge/​MLAB_panel/​SET10A$
-Nastavení skládání setu je v souboru ​layout.cfg ​a v soboru ​placement.merge.txt ​je uloženo požadované rozložení v setuSoubor s rozložením setu se vygeneruje atomaticky při prvním spuštění programu gerbmerge+Setting of set merging is found in the layout.cfg ​file and the placement.merge.txt ​file contains the requested set layoutA file with set layout will be generated automatically during the first startup of grebmerge programme.  
-Vygenerování takto připravených dat se provede následujícím příkazem:+ 
 +Generating such prepared data can be done using a following command:
   ../​../​src/​gerbmerge/​gerbmerge.py --place-file=placement.merge.txt layout.cfg   ../​../​src/​gerbmerge/​gerbmerge.py --place-file=placement.merge.txt layout.cfg
   ​   ​
 == GerberTools == == GerberTools ==
  
-[[https://​github.com/​ThisIsNotRocketScience/​GerberTools|GerberTools]] ​je zatím nevyzkoušený ​open-source ​nástroj napsaný primárně pro Windows ​C#.  +[[https://​github.com/​ThisIsNotRocketScience/​GerberTools|GerberTools]] ​is so far untried ​open-source ​tool written primarily for Windows ​in C#.
  
  
-==== Gkódy pro 3D tisk ====+==== Gcodes for 3D print ====
  
-Technologická ​data pro 3D tisk v MLABu generujeme programem ​[[http://​slic3r.org/​|Slic3r]]. ​Zatím od něj neexistují připravené balíky v použitelné verziProto je nutné program přeložit přímo ze zdrojových souborů na githubu+Technological ​data for 3D printing are in MLAB generating using [[http://​slic3r.org/​|Slic3r]] ​softwareSo far, there are not any ready-made usable packagesTherefore ​it is necessary to translate the programme directly from the source codes found on GitHub.
  
  
-=== Instalace ​Slic3r ===+=== Slic3r ​Installation ​===
  
   sudo apt-get install libextutils-cppguess-perl freeglut3-dev   sudo apt-get install libextutils-cppguess-perl freeglut3-dev
-=== Postup kompilace === 
  
-Z githubu se aktuálně používá master větevkterá je kompromisem mezi stabilitou ​možnostmi ​software. ​Samotná kompilace pak probíhá vetšinou podle instrukcí v souboru ​README.md+=== Compilation === 
 + 
 +Currently, a Github’s master branch is used - it is a compromise between stability and the software’s possibilitiesThe compilation itself is done mostly according to instructions from README.md ​file.
  
  
-===== Programátorské nástroje ​=====+===== Programming tools =====
  
-Na většinu programování softwaru se používá se v MLABu používá ​Python, nebo C. Vývojové nástroje jsou pro tyto jazyky dobře obecně známéVětšina vývoje je navíc orientována na Linux. ​ Proto zde uvedeme jen seznam nástrojů, které používáme+Most of the software programming in MLAB uses Python ​or C. Development tools for these languages are generally well knownFurthermore,​ most of the development is aimed at Linux. ​That is why we only provide a list of tools that we use
  
-==== Programovací ​GUI ====+==== Programming ​GUI ====
  
-Programovací prostředí v kterém je vytvářen zdrojový kódMezi uživateli jsou nejoblíbenější následující dvě volby. Jinak lze ale zdrojový kód psát v libovolném textovém editoru+A programming environment where the source code is createdThe most favourite among users are the following two option - however, the source code can be written in any text editor
  
 === Light Table === === Light Table ===
  
-[[http://​lighttable.com/​|Light Table]] ​je programátorský ​editor ​kódukterý vyniká speciálními vlastnostmi,​ jako je například interaktivní spouštění částí zdrojových kódů, nebo přímé vyhledávání v dokumentaci +[[http://​lighttable.com/​|Light Table]] ​is a code editor ​that excels at some special featuressuch as interactive running of sections of source code or direct search in documentationIts installation can be done by downloading a compiled package from [[http://​lighttable.com/​|Light Table Download]], ​unpacking it and running the following commands that will move it to system folders.
-Jeho instalaci do systému provedeme stažením zkompilovaného balíku z stránky ​[[http://​lighttable.com/​|Light Table Download]], ​rozbalením staženého balíku a provedením následujících příkazů, které jej přesunou do systémových složek.+
  
   sudo mv LightTable /​opt/​LightTable   sudo mv LightTable /​opt/​LightTable
Line 496: Line 496:
 === Sublime text === === Sublime text ===
  
-Multiplatformní placený ​editor ​pro linux, ​Windows, ​Mac OS.  Mezi jeho vyjímečné vlastnosti patří například náhled celého zdrojového kóduPro běžné použití stačí nezaplacená varze+A Multiplatform paid editor ​for linux, ​Window and Mac OS. Some of its special features include an overview of the whole source codeFree version is sufficient for ordinary use
  
-== Instalace v Ubuntu ==+== Ubuntu ​installation ​==
  
  
Line 504: Line 504:
   sudo apt-get update   sudo apt-get update
   sudo apt-get install sublime-text-installer   sudo apt-get install sublime-text-installer
 +
 === Code::​Blocks === === Code::​Blocks ===
  
-Jde o velmi rozřířený ​editor, jehož výhodou je, že běží na více platformách a mohou ho tedy používat i uživatelé windows.+A widely used editor. It’s advantage is that it runs under various platforms and thus can be used by Windows users as well
  
 [[http://​www.codeblocks.org/​|Code::​Blocks]] [[http://​www.codeblocks.org/​|Code::​Blocks]]
Line 513: Line 514:
   ​   ​
  
-==== Embeded ​systémy ​====+==== Embeded ​systems ​====
  
-Nástroje na programování jednotlivých typů mikrokontrolérů jsou většinou popsány v částech týkajících se programování u jednotlivých architektur: ​+Tools used for programming individual types of microcontrollers are mostly described in sections related to programming under different architectures.
  
 === PIC === === PIC ===
Line 523: Line 524:
 === AVR === === AVR ===
   * [[cs:​avr_programming|AVR]]   * [[cs:​avr_programming|AVR]]
-===== Správa verzí ​=====+===== Version Control ​=====
  
  
Line 531: Line 532:
 ==== GitHub ==== ==== GitHub ====
  
-Pro správu softwarového vývoje a dokumentace modulů používáme ​[[https://​github.com/​MLAB-project|github]]. ​+[[https://​github.com/​MLAB-project|github]] ​is used for management of software development and modules’ documentation.
  
 === Linux === === Linux ===
  
-Jako nejefektivnější uživatelské rozhraní pro git se osvědčil příkazový řádek s tím, že jeho efektivita je zde ještě markantnější než u SVN.+The most effective user interface for git seems to be the command line - here its efficiency is even more striking than in SVN.
  
-== Nový uživatel ​== +== New user ==
-Pro pohodlnou ptáci s git je efektivnější používat metodu klonování s SSH. Není při práci vyžadováno stále přihlašování. Komunikace je autentizována na základě privátního klíče. Pro každý počítač je potřeba vygenerovat unikátní klíč.+
  
-  - Je potřeba si založit uživatelský účet na https://​github.com/​ +For comfortable work with git it is effective ​to use a method of cloning with SSH - then there is no need for permanent logging in during workCommunication is authenticated base on privet ​key. Every computer needs to have unique one generated
-  - Následně je potřeba [[https://​help.github.com/​articles/​generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/​|vygenerovat na daném počítači ​SSH klíč]]. +
-  ​Vygenerovaný klíč je potřeba [[https://​help.github.com/​articles/​adding-a-new-ssh-key-to-your-github-account/​|vložit do účtu na githubu]] +
-  - Pokud v návodu nefunguje správně uložení klíče do schránky, tak je možné daný klíč získat otevřením skrytého souboru ​provést překopírování klíče ručně. ''​cat ~/​.ssh/​id_rsa.pub''​ +
-  - Tento postup stačí provést jen při prvním stahování na daném počítači.+
  
-== Základní příkazy ==+  - You need to create a user account on https://​github.com/​ 
 +  - Next, you have to [[https://​help.github.com/​articles/​generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/​|generate an SSH key for the specific computer]]. 
 +  - The generated key has to be [[https://​help.github.com/​articles/​adding-a-new-ssh-key-to-your-github-account/​|added into your github account]] 
 +  - If the addition of the key into clipboard (?? Schránka) does not work properly, it is possible to obtain the key via opening a hidden file and then copying the key manually. ‘’cat ~/​.ssh/​id_rsa.pub''​ 
 +  - This procedure only has to be done during the first download to a given computer.
  
-== Klonování repozitáře : ==+== Basic commands ​==
  
-  - Nejprve je potřeba vybrat místo, kde má být repozitář v počítači uložen ​v daném místě si otevřít příkazový řádek. +== Cloning ​repository ​==
-  - Příklad bude ukázán na repozitáři kicad-mlab: https://​github.com/​MLAB-project/​kicad-mlab +
-  - Na dané stránce si stáhneme potřebnou cestu k repozitáři. Webové tlačítko "Clone or download"​. +
-  - Je potřeba si přepnout cestu pro "Clone with SSH", na místo "Clone with HTTPS"​. +
-  - Pro náš případ cesta vypadá takto: git@github.com:​MLAB-project/​kicad-mlab.git +
-  - Nyní stačí v příkazové řádce zadat příkaz:+
  
 +  - First, you have to choose a place on your computer, where the repository will be saved and at that place, open the command line
 +  - As an example, we will use kicad-mlab repository: https://​github.com/​MLAB-project/​kicad-mlab
 +  - From the page, download the path to the repository - web button "Clone or download"​.
 +  - It is necessary to switch the path to "Clone with SSH" in stead of "Clone with HTTPS”.  ​
 +  - In our case, the path is as follows: git@github.com:​MLAB-project/​kicad-mlab.git
 +  - Run the following command in the command line:
  
   git clone git@github.com:​MLAB-project/​kicad-mlab.git   git clone git@github.com:​MLAB-project/​kicad-mlab.git
  
  
-  - Následně můžeme být vyzváni k zadání hesla, které jsme si zvolili při generování ​SSH klíče.+  - You may be asked to provide a password you have chosen during the SSH key generation ​
  
-== Stažení aktuální verze: ​==+== Downloading the current version ​==
  
-  - V místě uložení repozitáře je potřeba zadat v příkazové řádce následující příkaz:+  - In the folder with the saved repository, run the following command in the command line:
  
   git pull   git pull
  
  
-== Zjištění stavu aktuálnosti repozitáře ​==+== Finding out whether the repository is up-to-date ​==
  
   git status   git status
  
-Tento příkaz vypíše u jakých souborů došlo ke změně, nebo které byli přidány jako nové.+This command lists all the files that have been changed or added as new.
  
-== Přidání nového souboru, složky ​==+== Adding new file or folder ​==
  
-  git add název_souboru ​+  git add file_name ​
   ​   ​
-Po označení celé cesty z výpisu ​příkazů ​lze cestu vložit pomocí kliknutí na prostřední tlačítko myši+After marking (?? Označit) the whole path from the command list of commands (?? výpis ​příkazů), the path can be inserted by clicking on the middle mouse button.  
-Pro přidání ​všech změn lze použít ​```git add .```.+For submitting (?? Adding, ​přidání) all the changes, you can use ```git add .```.
                
-== Vytvoření commitu ​==+== Creating a commit ​==
  
-  git commit -m "Popis provedené změny"+  git commit -m “Description of the change"
  
-Po tomto příkazu je commit ​pouze v lokální kopii repozitářeAby se data odeslala na server ​je potřeba zadat následující příkaz.+After running the above-mentioned command, the commit ​is only in the local copy of the repositoryFor data to be sent to the server, see the next section.
  
-== Upload ​na server ==+== Upload ​to server ==
  
   git push    git push 
   ​   ​
-Pro ověřenízda veškeré úkony proběhly v pořádku je dobré se podívat na výstup příkazu:+It is helpful to list the output of the following commandto see if all the operation were done correctly.
  
   git status   git status
  
-Ve výpisu by neměly být žádné položky, které jsme chtěli nahrát    ​+The list should not contain any items that we wanted to upload.
       ​       ​
    
-== Změna velikosti lokálního repozitáře ​==+== Changing the size of the local repository ​==
  
-Git si ve výchozím nastavení stahuje celý repozitář včetně veškeré historie úpravToto lze zamezit při stahování repozitáře pomocí parametru ​```--depth=<​pocet stazenych commitu>​```+In its default setting, ​Git downloads the whole repository including all the edit historyThis can be prevented during the repository download by including ​```--depth=<​pocet stazenych commitu>​``` ​parameter.
  
   git clone <​adresa_repozitare>​ --depth=1   git clone <​adresa_repozitare>​ --depth=1
  
-Pokuď toto chcete aplikovat na existující kopii repozitáře,​ lze to provést následujícím postupem.+If you want to apply it onto an existing copy of the repository, you can use the following approach:
  
   git fetch --depth 2   git fetch --depth 2
   git reflog expire --expire=all --all   git reflog expire --expire=all --all
   git gc --prune=all   git gc --prune=all
- 
- 
- 
- 
- 
-  
  
  
 === Windows === === Windows ===
-[[https://​tortoisegit.org/​download/​|TortoiseGit]] ​Pod operačním systémem ​Windows ​je možné stahovat pohodlně ​data GitHub ​do počítače přes program ​[[cs:​tortoisegit|TortoiseGit]].+[[https://​tortoisegit.org/​download/​|TortoiseGit]] ​ 
 +Under Windows ​OS, data from GitHub ​can be comfortably download via a [[en:​tortoisegit|TortoiseGit]] ​programme
  
  
-===== Dokumentace vývoje ​=====+===== Documentation ​=====
  
-==== Textová dokumentace ​====+==== Text documentation ​====
  
-Veškeré textové dokumenty jsou v MLABu kódovány v UTF-8 někteří uživatelé ale požívají na editaci souborů windows a výsledkem je nekompatibilní souborkterý je třeba překódovat.+All MLAB text documents are UTF-8 coded. Some users however use Windows for editing files which may result in an incompatible filewhich needs to be re-coded
  
-Převod kódování textových souborů.+Converting the coding of text files.
  
   iconv -f WINDOWS-1250 -t UTF-8 zprava.txt ​ -o zprava.txt   iconv -f WINDOWS-1250 -t UTF-8 zprava.txt ​ -o zprava.txt
Line 636: Line 632:
 === Dokuwiki === === Dokuwiki ===
  
-Dokuwiki ​je systém ve kterém běží tato dokumentace.+Dokuwiki ​is a system that runs the documentation.
  
-== Offline ​editace ​==+== Offline ​editing ​==
  
-Podstatné ale ježje možné tuto dokumentaci editovat i offline, což se hodí zejména při cestování.+Documentation can be edited offlinewhich is a very useful feature that one can use e.g. during traveling
    
-K tomu je potřeba si na svém notebooku zprovoznit lokální instanci ​wiki. Tu si zprovozníme podle [[https://​www.dokuwiki.org/​install:​ubuntu#​alternative_easier_custom_installation|návodu na instalaci ​Dokuwiki ​pod Ubuntu]]. Data pak mezi oběma instancemi ​wiki synchronizujeme pomocí ​[[https://​www.dokuwiki.org/​plugin:​sync|pluginu ​sync]], který naistalujeme na svojí lokální instanci ​wiki. Po první synchronizaci se serverovou ​wiki můžeme stránky lokálně ​offline ​editovat a změny následně nahrát na veřejnou ​wiki MLAB+For offline editing to work, it is necessary to create a local wiki instance on your notebookIt can be done following a [[https://​www.dokuwiki.org/​install:​ubuntu#​alternative_easier_custom_installation| ​guide for Dokuwiki ​intallation for Ubuntu]]. 
 + 
 +Data between both wiki instances are synchronised with [[https://​www.dokuwiki.org/​plugin:​sync|sync ​plugin]] that is installed on the local wiki instanceAfter the first synchronisation with the server ​wiki we can locally edit the site offline ​and subsequently upload the changes to the public MLAB wiki.
  
 === LaTeX === === 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 outputThere 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
-  ​ 
-Po jejich istalaci je možné psát a editovat MLAB dokumenty napsané v [[http://​cs.wikipedia.org/​wiki/​LaTeX|LaTeXu]] 
  
-=== Dokuwiki a Latex ===+After their installation it is possible to write and edit MLAB documents written in [[http://​cs.wikipedia.org/​wiki/​LaTeX|LaTeXu]]
  
-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. ​+=== Dokuwiki ​and Latex ===
  
-Webová verze Pandoc ​umí zpracovat ​HTML kód o délce pouze do 1000 znakůJe proto vhodné si nainstalovat lokální ​offline ​verzi+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. 
 + 
 +A web version of Pandoc ​can process an HTML code with length only up to 1000 charactersTherefore, it is more usable to install a local offline ​version.
  
   sudo apt-get install pandoc   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   pandoc -f html -s -t latex temp_doc.html
   ​   ​
-Převedený dokument se nám pak vypíše do příkazové řádkyodkud jej pak stačí zkopírovat do Latexového editoru. +Converted document will be printed into the command linefrom 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 ​metoda tohoto převodu]]+[[http://​donaldmerand.com/​code/​2012/​07/​20/​how-i-actually-convert-dokuwiki-to-latex.html| Offline ​method of conversion]]
  
-==== Obrázková dokumentace ​====+==== Image documentation ​====
  
 === Dia === === Dia ===
  
-Program dia slouží na tvorbu diagramů a blokových schémat.+A Did software can create diagrams and block diagrams.
  
 === Fritzing === === 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 constructionsHowever, so far it does not support a mechanical placement of PCBsThat is why this tool is not widely used.
  
 === Prezi === === Prezi ===
  
-Je nástroj na tvorbu veřejných prezentací projektů+A tool for creating a public presentations of projects
  
 === ImageMagick ​ === === 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 kvalityAktuálně se hodnotí kvalita fotografie podle následujících kritérií+Every module has a quality mark assignedCurrently, a quality of photography is rated according to following criteria:
  
-  * 0 - žádná fotografie +  * 0 - no photo 
-  * 25 - render ​KiCAD +  * 25 - render ​from KiCAD 
-  * 50 - nekvalitní fotografie napřz telefonu +  * 50 - photo of low quality - e.gtaken 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 ==== ==== Redmine ====
  
-Je nástroj pro vytváření úkolů a dělbu práce na projektechJeho instance[[http://​www.mlab.cz/​redmine|běží na serveru]]. +A tool for creating tasks and division of labour on projectsIts 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 notebook ====
  
-Jupyter ​je softwarový nástroj, který umožňuje použít více výpočetních ​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 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   sudo pip install notebook
   ​   ​
-Spuštění se naopak provede ​+To run the software
  
   jupyter notebook   jupyter notebook
    
-Kde si pak zvolíme námi použitý ​kernel. ​+Where we chose the kernel.
  
   ​   ​
 ===== gnuradio ===== ===== 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
  
  
-====== ​Simulační nástroje ​======+====== ​Simulation tools ======
  
 =====  Nec2++ ===== =====  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 ==== ==== QAntenna ====
Line 753: Line 747:
 [[http://​qantenna.sourceforge.net/​download.php|QAntenna]] [[http://​qantenna.sourceforge.net/​download.php|QAntenna]]
  
-=== Kompilace ​===+=== Compilation ​===
    sudo apt-get install qtbase5-dev qttools5-dev    sudo apt-get install qtbase5-dev qttools5-dev
  
en/tools.1550071707.txt.gz · Last modified: 2019/02/13 16:28 by fluktuacia