sf-daq/ap
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
ozerov_d
2023-09-06 15:26:50 +02:00
parent a7e6b55b7a
commit 803503eea5
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -6,7 +6,6 @@ Runs on files produced by [sf-daq](https://github.com/paulscherrerinstitute/sf_d
# Table of Contents
* [Installation](#installation)
* [Configuration files](#config)
* [Google Authentication](#google-api)
* [Usage](#usage)
* [Before beamtime](#usage1)
@ -16,6 +15,7 @@ Runs on files produced by [sf-daq](https://github.com/paulscherrerinstitute/sf_d
* [data re-processing](#usage2_reprocess)
* [pausing indexing](#usage2_pause)
* [After beamtime](#usage3)
* [Configuration files](#config)
## Description
Automatic Processing tool checks for the new files/runs produced by sf-daq and runs automatically workload (currently - indexing (by crystfel)) and fills logbook (google spreadsheet) with information with some daq parameters from the sf-daq and processing.
@ -23,7 +23,7 @@ Automatic Processing tool checks for the new files/runs produced by sf-daq and r
## Installation<a name="installation"></a>
### Pre-installed software (recommended)
Automatic Processing tool is installed in /sf/jungfrau/applications/ap place and it's recommended to use if from that place (all examples below will be using that tool place).
Automatic Processing tool is installed in **/sf/jungfrau/applications/ap** place and it's recommended to use if from that place (all examples below will be using that tool place).
Installed conda environment can be activated with
```
@ -32,10 +32,13 @@ $ conda activate ap
```
### Installation from source
Automatic Processing tool can also be installed from scratch with:
Automatic Processing tool can also be installed from scratch (put this to the place which is accessible from online computing nodes. res/ directory of corresponding pgroup is perfect place for this):
```
$ git clone https://gitlab.psi.ch/sf-daq/ap.git # or via ssh with
# git clone git@gitlab.psi.ch:sf-daq/ap.git
```
Needed conda environment can be sourced/used from the common place. In case new conda environment is needed, please do (and don't use res/ for this purpose):
```
$ conda create -n ap gspread numpy matplotlib
$ conda activate ap
```