From 0e1bb68eb61bde1f6206948d67d91458f40a5984 Mon Sep 17 00:00:00 2001 From: Steffen Hauf <haufs@max-exfl057.desy.de> Date: Mon, 11 Jun 2018 22:10:27 +0200 Subject: [PATCH] More docs --- docs/source/.~how_it_works.rst | 0 docs/source/how_it_works.rst | 8 +++++--- docs/source/workflow.rst | 31 +++++++++++++++---------------- 3 files changed, 20 insertions(+), 19 deletions(-) create mode 100644 docs/source/.~how_it_works.rst diff --git a/docs/source/.~how_it_works.rst b/docs/source/.~how_it_works.rst new file mode 100644 index 000000000..e69de29bb diff --git a/docs/source/how_it_works.rst b/docs/source/how_it_works.rst index fe1f3640d..9534ee367 100644 --- a/docs/source/how_it_works.rst +++ b/docs/source/how_it_works.rst @@ -1,3 +1,5 @@ +.. _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 diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst index 069575099..d619f0533 100644 --- a/docs/source/workflow.rst +++ b/docs/source/workflow.rst @@ -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 -- GitLab