augustin_s/sf_databuffer
0
0
Fork 0
forked from archiver_config/sf_databuffer
Code Pull Requests Activity

Update Readme.md

Browse Source
This commit is contained in:
humar_t
2026-01-12 15:32:15 +01:00
parent 3540f7b363
commit 46e4e83e2a
1 changed files with 5 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
Readme.md
View File

@@ -3,50 +3,18 @@
This repository holds the requested bsread data sources and their data policies of the SwissFEL Data Buffer. This repository holds the requested bsread data sources and their data policies of the SwissFEL Data Buffer.
# Workflow - Request New Sources / Change Sources # Workflow - Request New Sources / Change Sources
This is the workflow
1. Create a forked repository of the current databuffer configuration repository and clone it to your home folder: 1. If you don't have permissions to push to this repo contact your supporter.
2. Clone the repo.
```bash 3. Push a branch with your name.
ssh sf-lc.psi.ch 4. Make a merge request.
cd ~
gitutils fork -c archiver_config/sf_databuffer
```
2. Go to the cloned repository and add/edit the files needed
```bash
cd ~/sf_databuffer
...
```
3. Commit your changes in the cloned local copy and push the changes to the server.
```bash
git commit -a -m "my commit message"
git push
```
4. Use `gitutils` to create automatically a merge request to the main repository on the git server.
```bash
gitutils merge -t "My Changes" -d "my merge request message"
```
Be aware: The best is to wait until a merge request was approved/closed before you create/open a new one!
More details on the gitutils command can be found at: https://gitutils.readthedocs.io/en/latest/
*If you know what you are doing and have permissions, push to master directly.*
# Administration # Administration
If there are new changes to this configuration (either through a merge request or direct commit) the configuration needs to be uploaded to the Data/Buffer. To do so clone or pull the latest changes from this repository and execute the `./bufferutils upload` script that comes with this repository (you have to be on a machine that have /opt/gfa/python available!). If there are new changes to this configuration (either through a merge request or direct commit) the configuration needs to be uploaded to the Data/Buffer. To do so clone or pull the latest changes from this repository and execute the `./bufferutils upload` script that comes with this repository (you have to be on a machine that have /opt/gfa/python available!).
Before approving/merging any changes make sure that the source is sending out data correctly
This can be done by connecting to one of the DataBuffer servers (e.g. __sf-daqbuf-21.psi.ch__) and execting the `bs-analyze` command:
```
bs-analyzer <source>:port
```
When pressing `CTRL+C` the programm gives a detailed report of the source.
## Uploading Sources ## Uploading Sources
To upload and start recording of all configured sources use: To upload and start recording of all configured sources use: