From 797d8b6b15c53d11196067930cb7d7310efc3c49 Mon Sep 17 00:00:00 2001 From: beale_j Date: Thu, 1 Feb 2024 09:39:22 +0100 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 65993e9..7130a99 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -# swissfel-sfx-tools +**swissfel-sfx-tools** A growing collection of tools for processing serial crystallography data at SwissFEL. At present the toolbox is composed of different folders that very loosely group the scripts into different tasks. These are - as of 01.02.2024: -- beamline-tools -- cells -- clen-tools -- cool-tools -- geom-files -- pyfai-tools -- reduction-tools +- beamline-tools => useful for beamline task - not for users +- cells => common crystfel .cell files used at the beamline +- clen-tools => tools to calculate the detector distance of a dataset +- cool-tools => need to update - probably going to be 'analysis tools' in the future +- geom-files => saved geometry files from past beamtimes +- pyfai-tools => useful for getting initial beam centre and detector distance use LaB6 powder diffraction and pyFAI +- reduction-tools => all scripts for getting pattern to integrated reflections +The vast majority are python scripts and use either in Cristallina or Alvra python environment provided at the beamtime. +A Cristallina environment that should always work can be loaded using: + +`source /sf/cristallina/applications/mx/conda/miniconda/bin/activate` +`conda activate crmx38-analysis`