Skip to content
Snippets Groups Projects
Verified Commit c1cbb2f7 authored by Robert Rosca's avatar Robert Rosca
Browse files

Improve formatting

parent 3d267c40
No related branches found
No related tags found
1 merge request!437Fix/requirements into setuppy
...@@ -196,8 +196,8 @@ yourself first: ...@@ -196,8 +196,8 @@ yourself first:
salloc -p exfel/upex -t 01:00:00 salloc -p exfel/upex -t 01:00:00
where `-p` gives the partition to use: exfel or upex and `-t` the duration the where `-p` gives the partition to use: exfel **or** upex and `-t` the duration
node should be allocated. Then `ssh` onto that node. the node should be allocated. Then ``ssh`` onto that node.
Then activate your environment as described above (or just continue if you are Then activate your environment as described above (or just continue if you are
not using a venv). not using a venv).
...@@ -224,15 +224,16 @@ Finally run the script: ...@@ -224,15 +224,16 @@ Finally run the script:
python3 calibrate.py --input /gpfs/exfel/exp/SPB/201701/p002012/raw/r0100 \ python3 calibrate.py --input /gpfs/exfel/exp/SPB/201701/p002012/raw/r0100 \
--output ../../test_out --mem-cells 30 --detector AGIPD --sequences 0,1 --output ../../test_out --mem-cells 30 --detector AGIPD --sequences 0,1
Here `--input` should point to a directory of `RAW` files for the detector you Here ``--input`` should point to a directory of ``RAW`` files for the detector
are calibrating. They will be output into the folder specified by `--output`, you are calibrating. They will be output into the folder specified by
which will have the run number or the last folder in the hierarchy of the input ``--output``, which will have the run number or the last folder in the hierarchy
appended. Additionally, you need to specify the number of `--mem-cells` used for of the input appended. Additionally, you need to specify the number of
the run, as well as the `--detector`. Finally, you can optionally specify to ``--mem-cells`` used for the run, as well as the ``--detector``. Finally, you
only process certain `--sequences` of files, matching the sequence numbers of can optionally specify to only process certain ``--sequences`` of files,
the `RAW` input. These should be given as a comma-separated list. matching the sequence numbers of the `RAW` input. These should be given as a
comma-separated list.
Finally, there is a `--no-relgain` option, which disables relative gain Finally, there is a ``--no-relgain`` option, which disables relative gain
correction. This can be useful while we still further characterize the detectors correction. This can be useful while we still further characterize the detectors
to provide accurate relative gain correction constants. to provide accurate relative gain correction constants.
...@@ -245,23 +246,23 @@ Important information that doesn't really fit in as part of the readme. ...@@ -245,23 +246,23 @@ Important information that doesn't really fit in as part of the readme.
TODO: Place this into the docs? Also, improve docs (out of scope for PR !437) TODO: Place this into the docs? Also, improve docs (out of scope for PR !437)
GitLab Access for xcaltst and xcal GitLab Access for ``xcaltst`` and ``xcal``
================================== ==========================================
To make it easier to work with and deploy software via xcaltst/xcal, we have To make it easier to work with and deploy software via ``xcaltst``/``xcal``, we
created an xcal account for gitlab with the following details: have created an xcal account for gitlab with the following details:
- Full Name: ReadOnly Gitlab Calibration External - Full Name: ReadOnly Gitlab Calibration External
- User ID: 423 - User ID: 423
- Username: xcalgitlab - Username: ``xcalgitlab``
- Password: ask Robert Rosca - Password: ask Robert Rosca
This account is intended to be used as a read only account which can be given This account is intended to be used as a read only account which can be given
access to certain repos to make it easier to clone them when using our access to certain repos to make it easier to clone them when using our
functional accounts on Maxwell. functional accounts on Maxwell.
The xcaltst account has an ed25519 keypair under ``~/.ssh/gitlab/``, the public The ``xcaltst`` account has an ed25519 keypair under ``~/.ssh/gitlab/``, the
key has been added to the xcalgitlab's approved SSH keys. public key has been added to the ``xcalgitlab``'s approved SSH keys.
Additionally this block has been added to ``~/.ssh/config``: Additionally this block has been added to ``~/.ssh/config``:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment