Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
F
famewoks
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
F-CRG
FAMEs
famewoks
Commits
1bf99e52
Commit
1bf99e52
authored
1 month ago
by
Mauro Rovezzi
Browse files
Options
Downloads
Patches
Plain Diff
some docs updt
parent
6df78617
No related branches found
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
doc/datamodel.md
+7
-2
7 additions, 2 deletions
doc/datamodel.md
doc/index.rst
+3
-3
3 additions, 3 deletions
doc/index.rst
doc/install_esrf.md
+9
-1
9 additions, 1 deletion
doc/install_esrf.md
doc/quickstart.md
+5
-0
5 additions, 0 deletions
doc/quickstart.md
with
24 additions
and
6 deletions
doc/datamodel.md
+
7
−
2
View file @
1bf99e52
...
...
@@ -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`
.
This diff is collapsed.
Click to expand it.
doc/index.rst
+
3
−
3
View file @
1bf99e52
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
doc/install_esrf.md
+
9
−
1
View file @
1bf99e52
...
...
@@ -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
This diff is collapsed.
Click to expand it.
doc/quickstart.md
+
5
−
0
View file @
1bf99e52
...
...
@@ -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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment