linse/seweb
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

make instructions more nice

Browse Source 
- use english consequently (this avoid umlauts...)
- adapt better to markdown syntax
This commit is contained in:
zolliker
2024-10-25 09:18:41 +02:00
parent 78cadd7bef
commit a22b70d750
1 changed files with 85 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
instructions_specifications.md
View File

@ -1,134 +1,145 @@
# Installation # Installation
python virtual env machen: create python virtual env (you might choose another name than 'myenv'):
> python3 -m venv myenv python3 -m venv myenv
aktivieren dieser venv (wiederholen bei jeder session): aktivate this venv (to be repeated for each session):
> source myenv/activate source myenv/activate
seweb git repo klonen (token ist max. ein Jahr gueltig): close seweb git repository (token is valid for one year only):
> git clone https://dm:krChVHhLuAntP-sG1T1g@gitlab.psi.ch/samenv/seweb.git git clone https://dm:krChVHhLuAntP-sG1T1g@gitlab.psi.ch/samenv/seweb.git
cd seweb
> cd seweb switch to your development branch:
in deinen Entwicklungsbranch wechseln: git switch daniel
> git switch daniel instal needed packages (goes into myenv)
noetige packages installieren (wird in myenv gepackt!) pip3 install -r requirements.txt
> pip3 install -r requirements.txt
# First Run # First Run
demo frappy server starten start demo frappy server
> frappy-server cryo,test -p 5000 frappy-server cryo,test -p 5000
dieses Terminal offen lassen, neues Terminal starten this terminal should stay open, now open another terminal and type:
> source myenv/activate source myenv/activate
> cd seweb cd seweb
dummy webserver starten, verbindet mit obigem frappy server start dummy webserver, connects with above frappy server
> ./dummy-webserver port=8888 instrument=test hostport=localhost:5000 ./dummy-webserver port=8888 instrument=test hostport=localhost:5000
webclient im browser starten mit http://localhost:8888/ start webclient in browser with http://localhost:8888/
# git # git
Branches anzeigen: show branches:
> git branch git branch
In deinen Branch gehen, wenn nicht schon da: switch to your branch, if not yet there:
> git switch daniel git switch daniel
## Aenderungen pushen ## Aenderungen pushen
fuer jede thematisch zusammenhaenge Aenderung einen Commit machen: make a commit for each batch of coherent code changes:
> git add <new files> git add <new files>
> git commit -a -m "repalce icons by nicer ones" git commit -a -m "replace icons by nicer ones"
Wenn Du den teil beginnend mit -m weglaesst, oeffnet sich der default Editor, If the part starting by '-m' is omitted, the default editor opens,
dann kannst Du auch mehrzeilige Kommentare machen. 1. Zeile: Titel, 2. Zeile leer this is helpful for create an extended commit message.
ab 3. Zeile: Text, nicht breiter als ca. 72 Zeichen Keep the following format: first line summary, empty 2nd line,
then more lines may follow. Keep witdh within about 72 chars.
> git push git push
## Aenderungen vom repo uebernehmen ## Merge changes from other developers
Wenn noch offene Aenderungen da sind, die Du noch nicht committen willst, Assume there are some changes in branch 'master' you want to
kannst Du diese Aenderungen zwischenlagern (ist ein Stapel!) include in your branch.
If you have uncommitted chanes you do not want to commit yet,
you may save this changes temporarely on a stack:
> git stash git stash
Zum master branch wechseln, und diesen runterziehen vom Repo: Change to master branch and pull the current version:
> git switch master git switch master
> git pull git pull
Die Aenderungen vom master in Deinen branch uebernehmen: Take over these changes in your branch:
> git switch daniel git switch daniel
> git rebase git rebase
Falls Konflikte entstehen, bekommst Du eine entsprechende Meldung If conflicts arise, read carefully the instructions and follow them.
Wenn diese geloest sind, Deine vorher zwischengespeicherten offenen Aenderungen zurueckholen After this, in case you did the git stash command above, you want get back your current modifications now:
> git stash pop git stash pop
# Specifications
## Tile Layout ## Tile Layout
4 types of blocks/tiles: 4 types of blocks/tiles:
graphics - graphics
moduleblock (list of modules with main values), (goodie: foldable groups) - moduleblock (list of modules with main values),
parblock (editable list of parameters) (goodie: foldable groups) (goodie: foldable groups, may need some changes in the server code)
logblock (log messages) placed in right bottom quarter - parblock (editable list of parameters) (goodie: foldable groups)
- logblock (log messages) placed in right bottom quarter
console is no longer used! console is no longer used!
(x) means a button in the top right corner (x) means a button in the top right corner
for narrow windows < 2w: for narrow windows < 2w:
show moduleblock by default
(x) on graphics: go to moduleblock - show moduleblock by default
(x) on modules: go to graphics - (x) on graphics: go to moduleblock
clicking on moduleblock: open parblock - (x) on modules: go to graphics
(x) on parblock: go to moduleblock - clicking on moduleblock: open parblock
logblock is shown by clicking on right bottom icon (not available with graphics) and hidden with (x) - (x) on parblock: go to moduleblock
allow to swipe when touch device is available (do we need this?) - logblock is shown by clicking on right bottom icon
(not available with graphics) and hidden with (x)
- allow to swipe when touch device is available (do we need this?)
for broader windows: for broader windows:
show graphics + moduleblock by default
(x) not shown on graphics by default - show graphics + moduleblock by default
(x) on modules: full screen graphics - (x) not shown on graphics by default
click on a module row (or a 'details' icon): add parblock, do not overwrite moduleblock when window is broad - (x) on modules: full screen graphics
enough (width > 3.5w) - click on a module row (or a 'details' icon): add parblock,
(x) on parblock (close parblock and reveal moduleblock if hidden) do not overwrite moduleblock when window is broad enough (width > 3.5w)
logblock is shown by clicking on right bottom icon and hidden with (x) - (x) on parblock (close parblock and reveal moduleblock if hidden)
swipe not possible - logblock is shown by clicking on right bottom icon and hidden with (x)
- swipe not possible
## moduleblocks ## moduleblocks
on each row: on each row:
colored indicator depending on status (yellow: driving, orange: warn, red: error) - colored indicator depending on status
red also when value is in error (yellow: busy, orange: warn, red: error)
edit icon for changing the target parameter of the module, if available - red also when value is in error
'details' icon for open the corresponding parblock - edit icon for changing the target parameter of the module,
if available
- 'details' icon for open the corresponding parblock
(instead or in addittion to link on name)
## parblocks ## parblocks
orange when parameter is in error (update message with error instead of value: show a little icon with hover orange when parameter is in error (update message with error
revealing error text) instead of value: show a little icon with hover revealing error text)
## logging ## logging
@ -136,8 +147,7 @@ use logging feature of SECoP - needs some work on the server (Markus)
## resizing window ## resizing window
hide parameters when size < 3.5w - hide parameters when size < 3.5w
hide graphics when size < 2w - hide graphics when size < 2w
show graphics when size > 2w - show graphics when size > 2w
it is not needed to show the parblock again when increasing width - it is not needed to show the parblock again when width is increased
nderungen wieder zur