From a5b5c88a1cec4cff600ca37604271c25f2655675 Mon Sep 17 00:00:00 2001 From: Cameron Voisey Date: Mon, 18 May 2020 12:54:07 +0100 Subject: [PATCH] Add info to docs on theories that are unavailable on the server, and point to theory db internally --- doc/sphinx/source/theory/theoryindex.rst | 11 +++++++++-- doc/sphinx/source/theory/theoryparamsinfo.md | 5 +++-- doc/sphinx/source/tutorials/list-resources.md | 4 ++++ 3 files changed, 16 insertions(+), 4 deletions(-) diff --git a/doc/sphinx/source/theory/theoryindex.rst b/doc/sphinx/source/theory/theoryindex.rst index c671a25d2f..8de7984ebb 100644 --- a/doc/sphinx/source/theory/theoryindex.rst +++ b/doc/sphinx/source/theory/theoryindex.rst @@ -1,8 +1,15 @@ +.. _theory-indexes: + Theory indexes ============== -In the table below you can see explicit content of the -``TheoryIndex`` table from the ``theory.db`` file. +In the table below you can see explicit content of the ``TheoryIndex`` table +from the ``theory.db`` file. Note that not every theory listed in the database +is available to be downloaded from the :ref:`NNPDF-server`. In particular, +theories that are outdated are not stored on the server, but their settings will +remain in the database. To find a list of the theories that are available on the +server, one can use the vp-list script (see :ref:`vp-list`) as so: :code:`vp- +list -r theories`. .. csv-table:: theory.db :file: ../theories.csv diff --git a/doc/sphinx/source/theory/theoryparamsinfo.md b/doc/sphinx/source/theory/theoryparamsinfo.md index 66a508c82f..01a933c191 100644 --- a/doc/sphinx/source/theory/theoryparamsinfo.md +++ b/doc/sphinx/source/theory/theoryparamsinfo.md @@ -1,8 +1,9 @@ # Looking up the parameters of a theory The parameters for all of the theories can be found in the `theory.db` file, -located in the `/share/NNPDF/data` directory. This is -an sqlite database file. +located in the `/share/NNPDF/data` directory. This is an +sqlite database file. The information contained within this file can also be +viewed [within the docs](theory-indexes). The tools required to extract the parameters for a given theory are already in the validphys framework: diff --git a/doc/sphinx/source/tutorials/list-resources.md b/doc/sphinx/source/tutorials/list-resources.md index dc96cf0648..1ebb83ba44 100644 --- a/doc/sphinx/source/tutorials/list-resources.md +++ b/doc/sphinx/source/tutorials/list-resources.md @@ -1,5 +1,9 @@ # How to list the available resources +```eval_rst +.. _vp-list: +``` + ## Using `vp-list` In order to check what resources are available locally and for download, use