Skip to content
Snippets Groups Projects
Commit 1bf99e52 authored by Mauro Rovezzi's avatar Mauro Rovezzi
Browse files

some docs updt

parent 6df78617
No related branches found
No related tags found
No related merge requests found
......@@ -18,6 +18,11 @@ in {numref}`fig_datamodel`. All data structures are represented by Python
standard `dataclasses`, as they provide a clear and concise way to define the
data structures and permits validation.
The data are organized in a tree-like structure (`famewoks.datamodel`):
The data are organized in a tree-like structure: Experimental session -> sample
-> dataset -> scan -> data. The data container is a Larch `Group`.
\ No newline at end of file
- Experimental session (`ExpSession`)
- -> sample (`ExpSample`)
- -> dataset (`ExpDataset`)
- -> scan (`XasScanGroup`)
The base data container is a Larch `Group`.
......@@ -11,12 +11,12 @@ This project is primarily targeted to the users of the FAME beamlines,
<https://www.esrf.fr/home/UsersAndScience/Experiments/CRG/BM16.html>`_ and
`FAME-PIX
<https://www.esrf.fr/home/UsersAndScience/Experiments/CRG/BM30.html>`_, the
French CRG spectroscopy beamlines at the ESRF. The goal is to help applying
French CRG X-ray spectroscopy beamlines at the ESRF. The goal is to help applying
common data reduction/analysis workflows at the beamline.
The code should be compatible with the data collected at other ESRF beamlines
The code should be compatible with any data collected at other ESRF beamlines
with the `BLISS <https://bliss.gitlab-pages.esrf.fr/bliss/master/>`_ control
software. But it has not been tested with such datasets.
software. But it has not been tested with such datasets yet.
The project is under **active development** and my be affected by bugs. Please,
subscribe to the `fame-data-analysis@esrf.fr` mailing list `here
......
......@@ -40,4 +40,12 @@ the kernel name that is showed (usually at the top right corner) is the one
defined by default, that is `Python 3 (ipykernel)`. This is because the
`famewoks` environment does not define a custom kernel. On `jupyter-slurm` you
do now have to choose a specific kernel, as it is on the beamline. Simply go
ahead and everything is fine.
\ No newline at end of file
ahead and everything is fine.
### What to do if I have a `PermissionError`?
It may happen that you are trying to read/write data from an experiment as
unauthorized user. In this case you will have a `PermissionError: [Errno 13]
Permission denied: ...` in the output trace. This can be solved by asking to the
main proposer of the experiment (or the local contact) to grant access to your
user account via the [https://data.esrf.fr/](https://data.esrf.fr/) portal.
\ No newline at end of file
......@@ -8,6 +8,11 @@ different scenarios:
- Simply connect to `http://jade:8000` and open the notebook in the `SCRIPTS`
directory of your experiment (usually at
`/data/visitor/your_proposal/bm16/your_session/`)
- If the notebook is not there, please ask your local contact to create one from
a previous experiment or download there the *Data reduction notebook* from
[https://gitlab.esrf.fr/F-CRG/fames/famewoks](https://gitlab.esrf.fr/F-CRG/fames/famewoks)
- Depending on the experiment, you may adapt the names of the counters. Ask your
local contact to get this information.
## Your experiment is finished and your data are not archived yet
......
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