Skip to content
Snippets Groups Projects
Commit 70adadf3 authored by Eric Kooistra's avatar Eric Kooistra
Browse files

Added how to create a DOI with zenodo.

parent 46cdf4cd
No related branches found
No related tags found
1 merge request!100Removed text for XSub that is now written in Confluence Subband correlator...
Hide whitespace changes
Inline Side-by-side
doc/erko_howto_tools.txt
+ 60
− 44
View file @ 70adadf3
......@@ -15,6 +15,8 @@
* Linux
* ICT diensten
* Python
* Zenodo DOI
......@@ -37,16 +39,16 @@
> cd ~/git/hdl
> . ./init_hdl.sh
> . ./init_hdl.sh
* init_hdl.sh defines:
- RADIOHDL_WORK directory for where the source code resides
- RADIOHDL_BUILD_DIR directory for where the targets will be build
- HDL_IOFILE_SIM_DIR=${RADIOHDL_BUILD_DIR}/sim for simulating with Modelsim using file IO
* init_hdl.sh copies git user_components.ipx into Altera dir's
- cp ${RADIOHDL_WORK}/hdl_user_components.ipx $altera_dir/ip/altera/user_components.ipx
* init_hdl.sh automatically also sources ../radiohdl/init_radiohdl.sh if necessary
......@@ -57,31 +59,31 @@ source also radiohdl tools
- RADIOHDL_GEAR directory of where the init_radiohdl.sh is located
- RADIOHDL_BUILD_DIR = ${RADIOHDL_BUILD_DIR}/build if not already defined
- RADIOHDL_CONFIG = ${RADIOHDL_GEAR}/config if not already defined
* init_radiohdl.sh extends:
- PATH with ${RADIOHDL_GEAR}/core
${RADIOHDL_GEAR}/quartus
${RADIOHDL_GEAR}/modelsim
- PYTHONPATH with ${RADIOHDL_GEAR}/core
${RADIOHDL_GEAR}/components
> compile_altera_simlibs unb1 # creates build/unb1/hdl_libraries_ip_stratixiv.txt
# creates build/quartus/<tool version> simulation models that need to be moved
# manually to $MODELSIM_ALTERA_LIBS_DIR/<tool version>
> generate_ip_libs unb1 # creates build/unb1/qmegawiz/
# creates build/unb1/quartus_sh --> empty dir, why is it there?
> quartus_config unb1 # creates build/unb1/quartus/<hdllib libraries> for synthesis
# creates build/unb1/quartus/technology_select_pkg.vhd
> modelsim_config unb1 # creates build/unb1/modelsim/<hdllib libraries> for simulation
# creates build/unb1/modelsim/modelsim_project_files.txt for Modelsim commands.do
# creates build/unb1/modelsim/technology_select_pkg.vhd
> run_qsys unb1 unb1_minimal_qsys # creates QSYS block in build/unb1/quartus/unb1_minimal_qsys
> run_qcomp unb1 unb1_minimal_qsys # creates
> run_qcomp unb1 unb1_minimal_qsys # creates
> run_modelsim unb1 &
......@@ -277,15 +279,15 @@ We identify two persons in this process:
* Work on branch using git add, commit and push
* Manually run regression test to test the changes (for Casacore SW the merge
request makes github automatically issue a regression test in the cloud, for
FW we need to run the relevant testbenches manually. It is not necessary to
FW we need to run the relevant testbenches manually. It is not necessary to
rerun the entire FW regression test, it is sufficient to only run the
regression test for the HDL libraries that were modified and the HDL
regression test for the HDL libraries that were modified and the HDL
libraries that could be impacted by the modification)
* Push the branch to the central repository at gitlab
* Push the branch to the central repository at gitlab
git push -u origin L2SDP-26 # first time to declare the branch at the remote
* Coder does merge request to reviewer using the central Gitlab GUI
* gitlab will warn if the branch will lead to a merge conflict, the coder then
first has to fix the merge conflict by merging the master to the branch:
......@@ -300,7 +302,7 @@ We identify two persons in this process:
git add file
git commit
git push
* In gitlab do merge request to reviewer
* Reviewer reviews the code per line or in general comments in gitlab GUI,
so reviewer does not need to pull the branch locally and also does not need
......@@ -313,19 +315,19 @@ We identify two persons in this process:
* When review is done then the reviewer does the merge.
* The merge automatically deletes the branch (if selected to do so in gitlab)
locally the coder manually needs to delete the branch:
git branch
git checkout master
git status
git branch -d L2SDP-26
git status
* Use Jira tag in commit message to have link between GIT and Jira. The link
was made via Settings/Intergations/Jira
Note:
* In github a merge request is called a pull request
* Default a pull pulls the master. Typically it is not necessary to pull a
* Default a pull pulls the master. Typically it is not necessary to pull a
branch because the reviewer does not need to compile and run the code and
because typically only one coder works on a branch.
......@@ -333,12 +335,7 @@ We hebben nog geen regel over sub-branches wel of niet. Als er geen duidelijk vo
ik alleen vanaf de master branchen, omdat je de branches dan onafhankelijk houdt van elkaar en
alle branches dan dezelfde referentie hebben. Voordat je een merge request van je branch naar een
bovenliggende branch doet, moet je eerst die bovenliggende branch mergen naar je branch.
*******************************************************************************
* SVN:
*******************************************************************************
svn -diff --diff-cmd='meld' [filepath] -r [revision]
*******************************************************************************
* Confluence:
......@@ -380,7 +377,7 @@ for me it is an ok workaround,
* Markdown
*******************************************************************************
See https://git.astron.nl/desp/args/Markdown/readme_markdown.txt
See https://git.astron.nl/desp/args/Markdown/readme_markdown.txt
*******************************************************************************
......@@ -408,20 +405,20 @@ bcksp |
|
j
*******************************************************************************
* Remote access
*******************************************************************************
* RDP:
Instead of Remote Desktop (RDP) use Remmina. It may be necessary to use:
> ssh -t -L 5900:localhost:5900 -C dop466 'x11vnc -localhost -display :0'
en daarna:
> remmina &
Note: Windows NTSERVER65 has IP: 10.87.3.165
* Login using ssh keys:
......@@ -461,11 +458,11 @@ Host dop421
ProxyCommand ssh -q -A astron netcat 10.87.0.221
*******************************************************************************
* License server
* License server
*******************************************************************************
export LM_LICENSE_FILE=1800@license4.astron.nl:1717@license5.astron.nl
ping 10.87.3.179 # = ping license4.astron.nl
ping 10.87.3.114 # = ping license5.astron.nl
......@@ -478,7 +475,7 @@ https://linuxize.com/post/how-to-use-linux-screen/
screen --version
Basic Linux Screen Usage
Basic Linux Screen Usage
On the command prompt, type screen.
Run the desired program.
......@@ -491,7 +488,7 @@ To start a screen session, simply type screen in your console:
screen
screen -S session_name
This will open a screen session, create a new window, and start a shell in
This will open a screen session, create a new window, and start a shell in
that window. Now that you have opened a screen session, you can get a list of
commands by typing:
......@@ -523,7 +520,7 @@ from the session. To resume your screen session use the following command:
screen -r
In case you have multiple screen sessions running on your machine, you will
In case you have multiple screen sessions running on your machine, you will
need to append the screen session ID after the r switch.
To find the session ID list the current running screen sessions with:
......@@ -570,10 +567,10 @@ Copy
1) Designs without QSYS: unb2b_arp_ping
Met meld blijkt dat de ip dir van unb2b_arp_ping en unb2b_minimal gelijk zijn
in de STAT-266 branch. Dat komt omdat je ze gecopieerd hebt en omdat
in de STAT-266 branch. Dat komt omdat je ze gecopieerd hebt en omdat
unb2b_arp_ping geen QSYS heeft zijn ze dus ongewijzigd.
Aangezien unb2b_arp_ping geen QSYS heeft, en ook niet zou krijgen, is het
Aangezien unb2b_arp_ping geen QSYS heeft, en ook niet zou krijgen, is het
beter om de unb2b_arp_ping/quartus/ip dir van unb2_arp_ping te deleten.
2) Designs with QSYS
......@@ -594,7 +591,7 @@ mag gebruiken, dus zonder naamswijziging.
ll $RADIOHDL_WORK/boards/uniboard2b/designs/unb2b_jesd/quartus/
ip/
qsys_unb2b_jesd.qsys
ll $RADIOHDL_WORK/boards/uniboard2b/designs/unb2b_jesd/quartus/ip/qsys_unb2b_minimal
total 2492
-rw-r--r-- 1 kooistra users 234095 Sep 23 13:01 altjesd_ss_RX_corepll.ip
......@@ -667,6 +664,11 @@ https://linuxize.com/
> apt-get dist-upgrade
> apt autoremove
# Henk Vosmeier
sudo apt-get upgrade
sudo apt-get dist-upgrade
sudo apt remove
# Login on dop386 and then power off:
> sudo shutdown
......@@ -678,6 +680,9 @@ dop466_0 = HDD
> gzip filename # zip file
> unzip filename.gz # unzip file
> zip -r apertif_matlab-v1.0.zip apertif_matlab
> zipinfo apertif_matlab-v1.0.zip
> grep -rl 'search text in files' . # -r for recursive, -l for only list filename
> find . -name *_thisfile.txt
......@@ -690,6 +695,7 @@ Start --> Administration --> Synaptic package manager
> sudo pip3 install numpy # to run Python3 library installer as root
> sudo apt-get install pip # to install Python2 library installer
> sudo apt-get install python-matplotlib
# ARGS doc gen
> sudo pip3 install --upgrade setuptools
......@@ -715,11 +721,6 @@ Start --> Administration --> Synaptic package manager
# Ethernet
> ifconfig
# Henk Vosmeier
sudo apt-get upgrade
sudo apt-get dist-upgrade
sudo apt remove
# primary group
# supplementary groups
......@@ -733,8 +734,8 @@ sudo usermod -a -G software kooistra # add user 'kooistra' to a Linux group 's
ls -l filename # shows current user,group owners of the 'filename'
sudo chgrp software filename # change group of 'filename' to 'software'
sudo chgrp -R software dirname # recursively change group of 'dirname' to 'software'
#chown # change user,group
sudo chown user_name file_name # change user,group
*******************************************************************************
* ICT diensten
......@@ -776,3 +777,18 @@ https://pypi.org/project/black/ # Python code formatter
numpy tutorial:
https://lwn.net/SubscriberLink/847039/3016fa7278000b77/
*******************************************************************************
* Zenodo DOI
*******************************************************************************
- login at https://zenodo.org/
- choose Upload in main menu --> my zenodo DOIs area
- choose New Upload button
- fill in all fields, reserve a DOI and do save
- check the README.md, NOTICE.md (with the DOI) and the LICENSE.md
- create the zip file
- upload the zip file and publish the DOI.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment