MLAB wiki

User Tools

Site Tools

Trace:
en:tools

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
en:tools [2019/02/18 14:20] – fluktuaciaen:tools [2019/03/18 22:34] – [Linux] fluktuacia
Line 552: Line 552:
 == Cloning a repository : == == Cloning a repository : ==
  
-  - Nejprve je potřeba vybrat místo, kde má být repozitář v počítači uložen a v daném místě si otevřít příkazový řádek. +  - First, you have to choose a place on your computer, where the repository will be saved and at that place, open the command line 
-  - Příklad bude ukázán na repozitáři kicad-mlab: https://github.com/MLAB-project/kicad-mlab +  - As an example, we will use kicad-mlab repository: 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". +  - From the page, download the path to the repository - web button "Clone or download". 
-  - Je potřeba si přepnout cestu pro "Clone with SSH", na místo "Clone with HTTPS". +  - It is necessary to switch the path to "Clone with SSH" in stead of "Clone with HTTPS”.   
-  - Pro náš případ cesta vypadá takto: git@github.com:MLAB-project/kicad-mlab.git +  - In our case, the path is as follows: git@github.com:MLAB-project/kicad-mlab.git 
-  - Nyní stačí v příkazové řádce zadat příkaz: +  - 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áře. Aby 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 repository. For 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 command, to 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 úprav. Toto 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 history. This 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 z 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í soubor, který 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 file, which 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 638: 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, že je možné tuto dokumentaci editovat i offline, což se hodí zejména při cestování.+Documentation can be edited offline, which 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 notebook. It 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 instance. After 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 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   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é řá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 === === 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 constructions. However, so far it does not support a mechanical placement of PCBs. That 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 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 ==== ==== 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 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   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 755: 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.txt · Last modified: 2023/02/02 22:39 by kaklik