diff --git a/doc/algorithms.rst b/doc/algorithms.rst index 1268fb76c9a2f4f65744b1da3f7d8b7061bd2fa6..c15e884aa7cdf55ac3cf826d42cc70e61640585b 100644 --- a/doc/algorithms.rst +++ b/doc/algorithms.rst @@ -23,8 +23,9 @@ .. _beat-core-algorithms: +=========== Algorithms -========== +=========== Algorithms are user-defined piece of software that run within the blocks of a toolchain. An algorithm can read data on the input(s) of the block and write diff --git a/doc/api.rst b/doc/api.rst index eb5654c4e57bbbc8d0c5aa7f0260e3ffc60a0d78..7944bba5b20e0cd428ccd5c0e4507d29cc5c95ad 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -21,8 +21,9 @@ .. with the BEAT platform. If not, see http:..www.gnu.org.licenses.. .. +==== API -=== +==== This section includes information for using the Python API of ``beat.core``. diff --git a/doc/backend_api.rst b/doc/backend_api.rst index b7879d10ba8185fcfddcbeb7dfa1ebb1d7d095ff..88ea148bd60b8d9633ae8269885095967110e90e 100644 --- a/doc/backend_api.rst +++ b/doc/backend_api.rst @@ -22,8 +22,9 @@ .. _beat-core-backend-api: +============ Backend API -=========== +============ As it is currently setup, user code at toolchain blocks running on the platform consumes data stored on disk and produces data which is stored on disk so that diff --git a/doc/databases.rst b/doc/databases.rst index 611836477e0ef14cbd0929e1d26cf781efa9a7fd..749974bc33778bf5dcf0da6d40d37f6da1ef7758 100644 --- a/doc/databases.rst +++ b/doc/databases.rst @@ -21,8 +21,9 @@ .. with the BEAT platform. If not, see http://www.gnu.org/licenses/. .. +========== Databases -========= +========== A database is a collection of data files, one for each output of the database. This data are inputs to the BEAT toolchains. Therefore, it is important to diff --git a/doc/dataformats.rst b/doc/dataformats.rst index 25ddc63e1fb83c45270ceb4366ffdc8f45d8b7b1..e97b636fe78e1e6fee8ceb2634e77d5f72e27a9d 100644 --- a/doc/dataformats.rst +++ b/doc/dataformats.rst @@ -23,8 +23,9 @@ .. _beat-core-dataformats: +============= Data formats -============ +============= Data formats formalize the interaction between algorithms and data sets, so they can communicate data in an orderly manner. All data formats produced or diff --git a/doc/develop.rst b/doc/develop.rst index e6188020f1966ba08c17b405dcadf2e63abc7cc7..6a8092f206af00cb340eb556ac0f120a8c4ce929 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -137,8 +137,9 @@ sphinx:: Other bits ---------- +========== Profiling -========= +========== In order to profile the test code, try the following:: diff --git a/doc/experiments.rst b/doc/experiments.rst index 61c8ee0df45151d1b89209b12ac1826d4414f78f..d392eda25fa865beca98fde38fb43b712b3eab19 100644 --- a/doc/experiments.rst +++ b/doc/experiments.rst @@ -23,8 +23,9 @@ .. _beat-core-experiments: +============ Experiments -=========== +============ An experiment is the reunion of algorithms, datasets, a toolchain and parameters that allow the platform to schedule and run the prescribed recipe diff --git a/doc/introduction.rst b/doc/introduction.rst index f9bfcc556ca175d76801cfced733de3e2037821b..bdf95746ee08f9dbe363fa36d2faf88eca8a5cb9 100644 --- a/doc/introduction.rst +++ b/doc/introduction.rst @@ -23,8 +23,9 @@ .. _beat-core-introduction: +============= Introduction -============ +============= The BEAT platform is a web-based system for certifying results for software-based data-driven workflows that can be sub-divided functionally (into diff --git a/doc/io.rst b/doc/io.rst index 8fe05eadc66e3111cb3384210784bb7f84e4bf73..488f542f05c3a60159396e5dde906a62723cf4da 100644 --- a/doc/io.rst +++ b/doc/io.rst @@ -23,8 +23,9 @@ .. _developerguide-io: +=============== Inputs/Outputs -============== +=============== .. _developerguide-io-introduction: diff --git a/doc/libraries.rst b/doc/libraries.rst index 4e6c1f870fb247de67133e0809bcafd8a5e17be8..3bd225f3b37d00427e47a678d0fd575221febcd9 100644 --- a/doc/libraries.rst +++ b/doc/libraries.rst @@ -23,8 +23,9 @@ .. _beat-core-libraries: +========== Libraries -========= +========== Algorithms are fundamental elements in the platform that formally describe how to process data. In particular, they are always attached to a specific diff --git a/doc/toolchains.rst b/doc/toolchains.rst index faac79383bf47df2ffd34cc6dbc3d6e6d1dc9289..08586892f9d7841cfc2816d2da006bb828b61689 100644 --- a/doc/toolchains.rst +++ b/doc/toolchains.rst @@ -23,8 +23,9 @@ .. _beat-core-toolchains: +=========== Toolchains -========== +=========== A toolchain describes the workflow of a particular experiment. Its declaration defines: