Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pycalibration
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Model registry
Analyze
Contributor 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
calibration
pycalibration
Commits
0e1bb68e
Commit
0e1bb68e
authored
6 years ago
by
Steffen Hauf
Browse files
Options
Downloads
Patches
Plain Diff
More docs
parent
f23025fa
No related branches found
No related tags found
1 merge request
!5
Clean
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
docs/source/.~how_it_works.rst
+0
-0
0 additions, 0 deletions
docs/source/.~how_it_works.rst
docs/source/how_it_works.rst
+5
-3
5 additions, 3 deletions
docs/source/how_it_works.rst
docs/source/workflow.rst
+15
-16
15 additions, 16 deletions
docs/source/workflow.rst
with
20 additions
and
19 deletions
docs/source/.~how_it_works.rst
0 → 100644
+
0
−
0
View file @
0e1bb68e
This diff is collapsed.
Click to expand it.
docs/source/how_it_works.rst
+
5
−
3
View file @
0e1bb68e
.. _how_it_works:
How it Works
============
...
...
@@ -7,11 +9,11 @@ to expose Jupyter_ notebooks to a command line interface.
Additionally, it leverages the DESY/XFEL Maxwell cluster to run these jobs in parallel
via SLURM_.
Here is a list of :ref:`
_
available_notebooks`
_
.
Here is a list of :ref:`available_notebooks`.
If you would like to integrate additional notebooks please see the :ref:`development_workflow`
_
.
If you would like to integrate additional notebooks please see the :ref:`development_workflow`.
.. _nbparameterise: https://github.com/takluyver/nbparameterise
.. _nbconver: https://github.com/jupyter/nbconvert
.. _jupyter: http://jupyter.org/
.. _SLURM: https://slurm.schedmd.com
\ No newline at end of file
.. _SLURM: https://slurm.schedmd.com
This diff is collapsed.
Click to expand it.
docs/source/workflow.rst
+
15
−
16
View file @
0e1bb68e
...
...
@@ -150,22 +150,21 @@ The following table contains a list of suggested names for certain parameters, a
to stay consistent amongst all notebooks.
.. table:: Suggested naming of parameters
Parameter name To be used for Special purpose
---------------- --------------------------------------------------------------- --------------------------
in_folder the input path data resides in, usually without a run number
out_folder path to write data out to, usually without a run number reports can be placed here
run(s) which XFEL DAQ runs to use, often ranges are allowed
modules refers to the modules of a segmented detector, ranges often ok.
sequences sequence files for the XFEL DAQ system, ranges are often ok.
cluster_profile name of the cluster profile for ipcluster fixed name
local_input read calibration constant from file, not database
local_output write calibration constant from file, not database
db_input read calibration constant from database, not file
db_output write calibration constant from database, not file
cal_db_interface the calibration database host in form of "tcp://host:port"
================ =============================================================== ==========================
Parameter name To be used for Special purpose
---------------- --------------------------------------------------------------- --------------------------
in_folder the input path data resides in, usually without a run number
out_folder path to write data out to, usually without a run number reports can be placed here
run(s) which XFEL DAQ runs to use, often ranges are allowed
modules refers to the modules of a segmented detector, ranges often ok.
sequences sequence files for the XFEL DAQ system, ranges are often ok.
cluster_profile name of the cluster profile for ipcluster fixed name
local_input read calibration constant from file, not database
local_output write calibration constant from file, not database
db_input read calibration constant from database, not file
db_output write calibration constant from database, not file
cal_db_interface the calibration database host in form of "tcp://host:port"
================ =============================================================== ==========================
Best Coding Practices
...
...
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