From d19eb0763371dce836c825bf37dce2eb49e22e68 Mon Sep 17 00:00:00 2001
From: martinRenou <martin.renou@isae.fr>
Date: Mon, 21 Aug 2017 14:30:02 +0100
Subject: [PATCH 1/5] Update the documentation
---
doc/source/design.rst | 9 ++++++++-
doc/source/introduction.rst | 5 +++--
doc/source/plugin_development.rst | 8 +++-----
3 files changed, 14 insertions(+), 8 deletions(-)
diff --git a/doc/source/design.rst b/doc/source/design.rst
index 574edbf..475604f 100644
--- a/doc/source/design.rst
+++ b/doc/source/design.rst
@@ -1,11 +1,12 @@
Design
------
-The application is based on three entities, as written in the introduction:
+The application is based on four entities, as written in the introduction:
- Multi Criteria Optimizer (MCO)
- DataSources
- Key Performance Indicator (KPI) Calculators
+- Notification Listeners
There are a few core assumptions about each of these entities:
@@ -18,6 +19,10 @@ There are a few core assumptions about each of these entities:
numerical result. This result is passed to the KPI calculators.
- The KPI calculators now compute the final KPIs that are then returned to
the invoker MCO.
+- The Notification Listener listens to the state of the MCO (Started/New step
+ of the computation/Finished). It can be a remote database which is filled
+ with the MCO results during the computation (e.g. the GUI `force_wfmanager`
+ has a notification listener in order to fill the result table).
The result can be represented with the following data flow
@@ -32,6 +37,8 @@ The result can be represented with the following data flow
5. one or more KPICalculators, which perform final data evaluation on the
obtained values, eac producing KPIResult...
6. Whose values are then returned to the MCO via the Communicator.
+7. The KPI values are then sent to the notification listeners with the
+ associated MCO parameters values
The resulting pipeline is therefore just two layers (DataSources, then
KPICalculators).
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 70d16fe..9d676ac 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -11,8 +11,10 @@ functionality. All functionality comes from external plugins, extending the
API to provide new entities, specifically:
- Multi Criteria Optimizer (MCO)
-- DataSources
+- DataSources, which can be a simulator or just a database
- Key Performance Indicator (KPI) Calculators
+- Notification Listeners, like a remote database which retrieve data during the
+ computation
Plugin support requires compliancy to the Force BDSS api for plugins.
Extensions are registered via setuptools entry points.
@@ -20,4 +22,3 @@ Extensions are registered via setuptools entry points.
Execution of the force bdss executable is simple. Invoke with::
force_bdss workflow.json
-
diff --git a/doc/source/plugin_development.rst b/doc/source/plugin_development.rst
index 278856a..3b50823 100644
--- a/doc/source/plugin_development.rst
+++ b/doc/source/plugin_development.rst
@@ -2,10 +2,10 @@ Plugin Development
------------------
A single Plugin can provide one or more of the pluggable entities
-described elsewhere (MCO/KPICalculators/DataSources). Multiple plugins can
-be installed to provide a broad range of functionalities.
+described elsewhere (MCO/KPICalculators/DataSources/NotificationListeners).
+Multiple plugins can be installed to provide a broad range of functionalities.
-Plugins must return Factories. Each Factory provides factory methods for
+Plugins must return Factories. Each Factory provides factory methods for
one of the above pluggable entities and its associated classes.
To implement a new plugin, you must
@@ -37,5 +37,3 @@ To implement a new plugin, you must
reimplementing its initialization defaults methods to return your factory.
- add the plugin class in the setup.py entry_point, under the namespace
``force.bdss.extensions``
-
-
--
GitLab
From dfffd3515508d95782e3169ed522767eeebd259a Mon Sep 17 00:00:00 2001
From: martinRenou <martin.renou@isae.fr>
Date: Mon, 21 Aug 2017 14:31:15 +0100
Subject: [PATCH 2/5] Fix style
---
doc/source/design.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/source/design.rst b/doc/source/design.rst
index 475604f..42edd6c 100644
--- a/doc/source/design.rst
+++ b/doc/source/design.rst
@@ -21,7 +21,7 @@ There are a few core assumptions about each of these entities:
the invoker MCO.
- The Notification Listener listens to the state of the MCO (Started/New step
of the computation/Finished). It can be a remote database which is filled
- with the MCO results during the computation (e.g. the GUI `force_wfmanager`
+ with the MCO results during the computation (e.g. the GUI ``force_wfmanager``
has a notification listener in order to fill the result table).
--
GitLab
From 2808205733061c710f79fdc11a4308eb412f42de Mon Sep 17 00:00:00 2001
From: martinRenou <martin.renou@isae.fr>
Date: Tue, 22 Aug 2017 10:57:10 +0100
Subject: [PATCH 3/5] make apidoc
---
doc/source/api/force_bdss.cli.rst | 8 +--
doc/source/api/force_bdss.cli.tests.rst | 8 +--
doc/source/api/force_bdss.core.rst | 20 ++++----
doc/source/api/force_bdss.core.tests.rst | 16 +++---
..._bdss.core_plugins.dummy.csv_extractor.rst | 16 +++---
...core_plugins.dummy.csv_extractor.tests.rst | 12 ++---
...e_bdss.core_plugins.dummy.dummy_dakota.rst | 24 ++++-----
....core_plugins.dummy.dummy_dakota.tests.rst | 16 +++---
...s.core_plugins.dummy.dummy_data_source.rst | 16 +++---
..._plugins.dummy.dummy_data_source.tests.rst | 12 ++---
...ore_plugins.dummy.dummy_kpi_calculator.rst | 16 +++---
...ugins.dummy.dummy_kpi_calculator.tests.rst | 12 ++---
...gins.dummy.dummy_notification_listener.rst | 45 ++++++++++++++++
...ummy.dummy_notification_listener.tests.rst | 38 ++++++++++++++
...orce_bdss.core_plugins.dummy.kpi_adder.rst | 16 +++---
...dss.core_plugins.dummy.kpi_adder.tests.rst | 12 ++---
.../api/force_bdss.core_plugins.dummy.rst | 9 ++--
.../force_bdss.core_plugins.dummy.tests.rst | 16 +++---
doc/source/api/force_bdss.core_plugins.rst | 4 +-
doc/source/api/force_bdss.data_sources.rst | 20 ++++----
.../api/force_bdss.data_sources.tests.rst | 16 +++---
doc/source/api/force_bdss.io.rst | 12 ++---
doc/source/api/force_bdss.io.tests.rst | 12 ++---
doc/source/api/force_bdss.kpi.rst | 20 ++++----
doc/source/api/force_bdss.kpi.tests.rst | 16 +++---
doc/source/api/force_bdss.mco.parameters.rst | 12 ++---
.../api/force_bdss.mco.parameters.tests.rst | 12 ++---
doc/source/api/force_bdss.mco.rst | 24 ++++-----
doc/source/api/force_bdss.mco.tests.rst | 16 +++---
.../api/force_bdss.notification_listeners.rst | 46 +++++++++++++++++
doc/source/api/force_bdss.rst | 51 +++++++++++--------
doc/source/api/force_bdss.tests.fixtures.rst | 4 +-
doc/source/api/force_bdss.tests.rst | 40 ++++++++++-----
33 files changed, 386 insertions(+), 231 deletions(-)
create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.rst
create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.tests.rst
create mode 100644 doc/source/api/force_bdss.notification_listeners.rst
diff --git a/doc/source/api/force_bdss.cli.rst b/doc/source/api/force_bdss.cli.rst
index c96292e..c6f155f 100644
--- a/doc/source/api/force_bdss.cli.rst
+++ b/doc/source/api/force_bdss.cli.rst
@@ -1,5 +1,5 @@
-force_bdss.cli package
-======================
+force\_bdss\.cli package
+========================
Subpackages
-----------
@@ -11,8 +11,8 @@ Subpackages
Submodules
----------
-force_bdss.cli.force_bdss module
---------------------------------
+force\_bdss\.cli\.force\_bdss module
+------------------------------------
.. automodule:: force_bdss.cli.force_bdss
:members:
diff --git a/doc/source/api/force_bdss.cli.tests.rst b/doc/source/api/force_bdss.cli.tests.rst
index 5fef4d6..207d951 100644
--- a/doc/source/api/force_bdss.cli.tests.rst
+++ b/doc/source/api/force_bdss.cli.tests.rst
@@ -1,11 +1,11 @@
-force_bdss.cli.tests package
-============================
+force\_bdss\.cli\.tests package
+===============================
Submodules
----------
-force_bdss.cli.tests.test_execution module
-------------------------------------------
+force\_bdss\.cli\.tests\.test\_execution module
+-----------------------------------------------
.. automodule:: force_bdss.cli.tests.test_execution
:members:
diff --git a/doc/source/api/force_bdss.core.rst b/doc/source/api/force_bdss.core.rst
index 06471ee..84e7753 100644
--- a/doc/source/api/force_bdss.core.rst
+++ b/doc/source/api/force_bdss.core.rst
@@ -1,5 +1,5 @@
-force_bdss.core package
-=======================
+force\_bdss\.core package
+=========================
Subpackages
-----------
@@ -11,32 +11,32 @@ Subpackages
Submodules
----------
-force_bdss.core.data_value module
----------------------------------
+force\_bdss\.core\.data\_value module
+-------------------------------------
.. automodule:: force_bdss.core.data_value
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core.input_slot_map module
--------------------------------------
+force\_bdss\.core\.input\_slot\_map module
+------------------------------------------
.. automodule:: force_bdss.core.input_slot_map
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core.slot module
----------------------------
+force\_bdss\.core\.slot module
+------------------------------
.. automodule:: force_bdss.core.slot
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core.workflow module
--------------------------------
+force\_bdss\.core\.workflow module
+----------------------------------
.. automodule:: force_bdss.core.workflow
:members:
diff --git a/doc/source/api/force_bdss.core.tests.rst b/doc/source/api/force_bdss.core.tests.rst
index 21f5407..046bd59 100644
--- a/doc/source/api/force_bdss.core.tests.rst
+++ b/doc/source/api/force_bdss.core.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.core.tests package
-=============================
+force\_bdss\.core\.tests package
+================================
Submodules
----------
-force_bdss.core.tests.test_data_value module
---------------------------------------------
+force\_bdss\.core\.tests\.test\_data\_value module
+--------------------------------------------------
.. automodule:: force_bdss.core.tests.test_data_value
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core.tests.test_input_slot_map module
-------------------------------------------------
+force\_bdss\.core\.tests\.test\_input\_slot\_map module
+-------------------------------------------------------
.. automodule:: force_bdss.core.tests.test_input_slot_map
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core.tests.test_slot module
---------------------------------------
+force\_bdss\.core\.tests\.test\_slot module
+-------------------------------------------
.. automodule:: force_bdss.core.tests.test_slot
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst
index e1bfabe..42bd5ae 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy.csv_extractor package
-===================================================
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor package
+=========================================================
Subpackages
-----------
@@ -11,24 +11,24 @@ Subpackages
Submodules
----------
-force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_data_source module
-----------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_data\_source module
+--------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_factory module
-------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_factory module
+---------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_model module
-----------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.csv\_extractor\_model module
+-------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_model
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst
index bc15d4c..d1f1dff 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.core_plugins.dummy.csv_extractor.tests package
-=========================================================
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests package
+================================================================
Submodules
----------
-force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_data_source module
----------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests\.test\_csv\_extractor\_data\_source module
+---------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_factory module
------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.csv\_extractor\.tests\.test\_csv\_extractor\_factory module
+----------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_factory
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst
index da727e9..6092e64 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy.dummy_dakota package
-==================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota package
+========================================================
Subpackages
-----------
@@ -11,40 +11,40 @@ Subpackages
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_dakota.dakota_communicator module
----------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_communicator module
+-----------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_communicator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.dakota_factory module
-----------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_factory module
+------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.dakota_model module
---------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_model module
+----------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_model
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.dakota_optimizer module
-------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_optimizer module
+--------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_optimizer
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.parameters module
-------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.parameters module
+-------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.parameters
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst
index f16cfb6..1982bc3 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_dakota.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.core_plugins.dummy.dummy_dakota.tests package
-========================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests package
+===============================================================
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_communicator module
---------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_communicator module
+------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_communicator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_factory module
----------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_factory module
+-------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_optimizer module
------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.tests\.test\_dakota\_optimizer module
+---------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_optimizer
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst
index d0d5add..1f144b3 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy.dummy_data_source package
-=======================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source package
+==============================================================
Subpackages
-----------
@@ -11,24 +11,24 @@ Subpackages
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source module
-------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source module
+----------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_factory module
---------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source\_factory module
+-------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_model module
-------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.dummy\_data\_source\_model module
+-----------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_model
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst
index ba04010..f41ad61 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_data_source.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.core_plugins.dummy.dummy_data_source.tests package
-=============================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests package
+=====================================================================
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source module
------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests\.test\_dummy\_data\_source module
+-----------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_factory module
--------------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_data\_source\.tests\.test\_dummy\_data\_source\_factory module
+--------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_factory
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst
index c4b53e3..421db22 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy.dummy_kpi_calculator package
-==========================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator package
+=================================================================
Subpackages
-----------
@@ -11,24 +11,24 @@ Subpackages
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator module
-------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator module
+----------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_factory module
---------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator\_factory module
+-------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_model module
-------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.dummy\_kpi\_calculator\_model module
+-----------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_model
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst
index 99dbeff..1b91f02 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests package
-================================================================
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests package
+========================================================================
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator module
------------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests\.test\_dummy\_kpi\_calculator module
+-----------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_factory module
--------------------------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_kpi\_calculator\.tests\.test\_dummy\_kpi\_calculator\_factory module
+--------------------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_factory
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.rst
new file mode 100644
index 0000000..ba025cc
--- /dev/null
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.rst
@@ -0,0 +1,45 @@
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener package
+========================================================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ force_bdss.core_plugins.dummy.dummy_notification_listener.tests
+
+Submodules
+----------
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener module
+------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener\_factory module
+---------------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.dummy\_notification\_listener\_model module
+-------------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.dummy_notification_listener_model
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.tests.rst
new file mode 100644
index 0000000..6cdd3cf
--- /dev/null
+++ b/doc/source/api/force_bdss.core_plugins.dummy.dummy_notification_listener.tests.rst
@@ -0,0 +1,38 @@
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests package
+===============================================================================
+
+Submodules
+----------
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener module
+-------------------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener\_factory module
+----------------------------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.dummy\_notification\_listener\.tests\.test\_dummy\_notification\_listener\_model module
+--------------------------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests.test_dummy_notification_listener_model
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_notification_listener.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst
index 67bf402..6167c3f 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy.kpi_adder package
-===============================================
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder package
+=====================================================
Subpackages
-----------
@@ -11,24 +11,24 @@ Subpackages
Submodules
----------
-force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_calculator module
--------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_calculator module
+----------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_factory module
-----------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_factory module
+-------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_model module
---------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.kpi\_adder\_model module
+-----------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_model
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst
index bde777c..4412e83 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.kpi_adder.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.core_plugins.dummy.kpi_adder.tests package
-=====================================================
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests package
+============================================================
Submodules
----------
-force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_calculator module
-------------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests\.test\_kpi\_adder\_calculator module
+-----------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_factory module
----------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.kpi\_adder\.tests\.test\_kpi\_adder\_factory module
+--------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_factory
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.rst b/doc/source/api/force_bdss.core_plugins.dummy.rst
index 6d5b57b..ae1d819 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins.dummy package
-=====================================
+force\_bdss\.core\_plugins\.dummy package
+=========================================
Subpackages
-----------
@@ -10,14 +10,15 @@ Subpackages
force_bdss.core_plugins.dummy.dummy_dakota
force_bdss.core_plugins.dummy.dummy_data_source
force_bdss.core_plugins.dummy.dummy_kpi_calculator
+ force_bdss.core_plugins.dummy.dummy_notification_listener
force_bdss.core_plugins.dummy.kpi_adder
force_bdss.core_plugins.dummy.tests
Submodules
----------
-force_bdss.core_plugins.dummy.dummy_plugin module
--------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.dummy\_plugin module
+-------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_plugin
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.tests.rst
index 5796f32..41e0d30 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.core_plugins.dummy.tests package
-===========================================
+force\_bdss\.core\_plugins\.dummy\.tests package
+================================================
Submodules
----------
-force_bdss.core_plugins.dummy.tests.data_source_factory_test_mixin module
--------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.tests\.data\_source\_factory\_test\_mixin module
+-----------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.data_source_factory_test_mixin
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.tests.kpi_calculator_factory_test_mixin module
-----------------------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.tests\.kpi\_calculator\_factory\_test\_mixin module
+--------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.kpi_calculator_factory_test_mixin
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_plugins.dummy.tests.test_direct_execution module
-----------------------------------------------------------------
+force\_bdss\.core\_plugins\.dummy\.tests\.test\_direct\_execution module
+------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.test_direct_execution
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.rst b/doc/source/api/force_bdss.core_plugins.rst
index aabfada..d667de4 100644
--- a/doc/source/api/force_bdss.core_plugins.rst
+++ b/doc/source/api/force_bdss.core_plugins.rst
@@ -1,5 +1,5 @@
-force_bdss.core_plugins package
-===============================
+force\_bdss\.core\_plugins package
+==================================
Subpackages
-----------
diff --git a/doc/source/api/force_bdss.data_sources.rst b/doc/source/api/force_bdss.data_sources.rst
index f984d6d..871f272 100644
--- a/doc/source/api/force_bdss.data_sources.rst
+++ b/doc/source/api/force_bdss.data_sources.rst
@@ -1,5 +1,5 @@
-force_bdss.data_sources package
-===============================
+force\_bdss\.data\_sources package
+==================================
Subpackages
-----------
@@ -11,32 +11,32 @@ Subpackages
Submodules
----------
-force_bdss.data_sources.base_data_source module
------------------------------------------------
+force\_bdss\.data\_sources\.base\_data\_source module
+-----------------------------------------------------
.. automodule:: force_bdss.data_sources.base_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.data_sources.base_data_source_factory module
--------------------------------------------------------
+force\_bdss\.data\_sources\.base\_data\_source\_factory module
+--------------------------------------------------------------
.. automodule:: force_bdss.data_sources.base_data_source_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.data_sources.base_data_source_model module
------------------------------------------------------
+force\_bdss\.data\_sources\.base\_data\_source\_model module
+------------------------------------------------------------
.. automodule:: force_bdss.data_sources.base_data_source_model
:members:
:undoc-members:
:show-inheritance:
-force_bdss.data_sources.i_data_source_factory module
-----------------------------------------------------
+force\_bdss\.data\_sources\.i\_data\_source\_factory module
+-----------------------------------------------------------
.. automodule:: force_bdss.data_sources.i_data_source_factory
:members:
diff --git a/doc/source/api/force_bdss.data_sources.tests.rst b/doc/source/api/force_bdss.data_sources.tests.rst
index 16d8fcd..e54155a 100644
--- a/doc/source/api/force_bdss.data_sources.tests.rst
+++ b/doc/source/api/force_bdss.data_sources.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.data_sources.tests package
-=====================================
+force\_bdss\.data\_sources\.tests package
+=========================================
Submodules
----------
-force_bdss.data_sources.tests.test_base_data_source module
-----------------------------------------------------------
+force\_bdss\.data\_sources\.tests\.test\_base\_data\_source module
+------------------------------------------------------------------
.. automodule:: force_bdss.data_sources.tests.test_base_data_source
:members:
:undoc-members:
:show-inheritance:
-force_bdss.data_sources.tests.test_base_data_source_factory module
-------------------------------------------------------------------
+force\_bdss\.data\_sources\.tests\.test\_base\_data\_source\_factory module
+---------------------------------------------------------------------------
.. automodule:: force_bdss.data_sources.tests.test_base_data_source_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.data_sources.tests.test_base_data_source_model module
-----------------------------------------------------------------
+force\_bdss\.data\_sources\.tests\.test\_base\_data\_source\_model module
+-------------------------------------------------------------------------
.. automodule:: force_bdss.data_sources.tests.test_base_data_source_model
:members:
diff --git a/doc/source/api/force_bdss.io.rst b/doc/source/api/force_bdss.io.rst
index c221828..558ecbe 100644
--- a/doc/source/api/force_bdss.io.rst
+++ b/doc/source/api/force_bdss.io.rst
@@ -1,5 +1,5 @@
-force_bdss.io package
-=====================
+force\_bdss\.io package
+=======================
Subpackages
-----------
@@ -11,16 +11,16 @@ Subpackages
Submodules
----------
-force_bdss.io.workflow_reader module
-------------------------------------
+force\_bdss\.io\.workflow\_reader module
+----------------------------------------
.. automodule:: force_bdss.io.workflow_reader
:members:
:undoc-members:
:show-inheritance:
-force_bdss.io.workflow_writer module
-------------------------------------
+force\_bdss\.io\.workflow\_writer module
+----------------------------------------
.. automodule:: force_bdss.io.workflow_writer
:members:
diff --git a/doc/source/api/force_bdss.io.tests.rst b/doc/source/api/force_bdss.io.tests.rst
index d7512c8..7a53cce 100644
--- a/doc/source/api/force_bdss.io.tests.rst
+++ b/doc/source/api/force_bdss.io.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.io.tests package
-===========================
+force\_bdss\.io\.tests package
+==============================
Submodules
----------
-force_bdss.io.tests.test_workflow_reader module
------------------------------------------------
+force\_bdss\.io\.tests\.test\_workflow\_reader module
+-----------------------------------------------------
.. automodule:: force_bdss.io.tests.test_workflow_reader
:members:
:undoc-members:
:show-inheritance:
-force_bdss.io.tests.test_workflow_writer module
------------------------------------------------
+force\_bdss\.io\.tests\.test\_workflow\_writer module
+-----------------------------------------------------
.. automodule:: force_bdss.io.tests.test_workflow_writer
:members:
diff --git a/doc/source/api/force_bdss.kpi.rst b/doc/source/api/force_bdss.kpi.rst
index 2215a99..a18dcbd 100644
--- a/doc/source/api/force_bdss.kpi.rst
+++ b/doc/source/api/force_bdss.kpi.rst
@@ -1,5 +1,5 @@
-force_bdss.kpi package
-======================
+force\_bdss\.kpi package
+========================
Subpackages
-----------
@@ -11,32 +11,32 @@ Subpackages
Submodules
----------
-force_bdss.kpi.base_kpi_calculator module
------------------------------------------
+force\_bdss\.kpi\.base\_kpi\_calculator module
+----------------------------------------------
.. automodule:: force_bdss.kpi.base_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.kpi.base_kpi_calculator_factory module
--------------------------------------------------
+force\_bdss\.kpi\.base\_kpi\_calculator\_factory module
+-------------------------------------------------------
.. automodule:: force_bdss.kpi.base_kpi_calculator_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.kpi.base_kpi_calculator_model module
------------------------------------------------
+force\_bdss\.kpi\.base\_kpi\_calculator\_model module
+-----------------------------------------------------
.. automodule:: force_bdss.kpi.base_kpi_calculator_model
:members:
:undoc-members:
:show-inheritance:
-force_bdss.kpi.i_kpi_calculator_factory module
-----------------------------------------------
+force\_bdss\.kpi\.i\_kpi\_calculator\_factory module
+----------------------------------------------------
.. automodule:: force_bdss.kpi.i_kpi_calculator_factory
:members:
diff --git a/doc/source/api/force_bdss.kpi.tests.rst b/doc/source/api/force_bdss.kpi.tests.rst
index 3ab64ce..d45f293 100644
--- a/doc/source/api/force_bdss.kpi.tests.rst
+++ b/doc/source/api/force_bdss.kpi.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.kpi.tests package
-============================
+force\_bdss\.kpi\.tests package
+===============================
Submodules
----------
-force_bdss.kpi.tests.test_base_kpi_calculator module
-----------------------------------------------------
+force\_bdss\.kpi\.tests\.test\_base\_kpi\_calculator module
+-----------------------------------------------------------
.. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.kpi.tests.test_base_kpi_calculator_factory module
-------------------------------------------------------------
+force\_bdss\.kpi\.tests\.test\_base\_kpi\_calculator\_factory module
+--------------------------------------------------------------------
.. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.kpi.tests.test_base_kpi_calculator_model module
-----------------------------------------------------------
+force\_bdss\.kpi\.tests\.test\_base\_kpi\_calculator\_model module
+------------------------------------------------------------------
.. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator_model
:members:
diff --git a/doc/source/api/force_bdss.mco.parameters.rst b/doc/source/api/force_bdss.mco.parameters.rst
index bf6d87c..f01c2f1 100644
--- a/doc/source/api/force_bdss.mco.parameters.rst
+++ b/doc/source/api/force_bdss.mco.parameters.rst
@@ -1,5 +1,5 @@
-force_bdss.mco.parameters package
-=================================
+force\_bdss\.mco\.parameters package
+====================================
Subpackages
-----------
@@ -11,16 +11,16 @@ Subpackages
Submodules
----------
-force_bdss.mco.parameters.base_mco_parameter module
----------------------------------------------------
+force\_bdss\.mco\.parameters\.base\_mco\_parameter module
+---------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.base_mco_parameter
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.parameters.base_mco_parameter_factory module
------------------------------------------------------------
+force\_bdss\.mco\.parameters\.base\_mco\_parameter\_factory module
+------------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.base_mco_parameter_factory
:members:
diff --git a/doc/source/api/force_bdss.mco.parameters.tests.rst b/doc/source/api/force_bdss.mco.parameters.tests.rst
index def0b61..fa013a8 100644
--- a/doc/source/api/force_bdss.mco.parameters.tests.rst
+++ b/doc/source/api/force_bdss.mco.parameters.tests.rst
@@ -1,19 +1,19 @@
-force_bdss.mco.parameters.tests package
-=======================================
+force\_bdss\.mco\.parameters\.tests package
+===========================================
Submodules
----------
-force_bdss.mco.parameters.tests.test_base_mco_parameter module
---------------------------------------------------------------
+force\_bdss\.mco\.parameters\.tests\.test\_base\_mco\_parameter module
+----------------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.tests.test_base_mco_parameter
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.parameters.tests.test_base_mco_parameter_factory module
-----------------------------------------------------------------------
+force\_bdss\.mco\.parameters\.tests\.test\_base\_mco\_parameter\_factory module
+-------------------------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.tests.test_base_mco_parameter_factory
:members:
diff --git a/doc/source/api/force_bdss.mco.rst b/doc/source/api/force_bdss.mco.rst
index 9e86c87..62b36b0 100644
--- a/doc/source/api/force_bdss.mco.rst
+++ b/doc/source/api/force_bdss.mco.rst
@@ -1,5 +1,5 @@
-force_bdss.mco package
-======================
+force\_bdss\.mco package
+========================
Subpackages
-----------
@@ -12,40 +12,40 @@ Subpackages
Submodules
----------
-force_bdss.mco.base_mco module
-------------------------------
+force\_bdss\.mco\.base\_mco module
+----------------------------------
.. automodule:: force_bdss.mco.base_mco
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.base_mco_communicator module
--------------------------------------------
+force\_bdss\.mco\.base\_mco\_communicator module
+------------------------------------------------
.. automodule:: force_bdss.mco.base_mco_communicator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.base_mco_factory module
---------------------------------------
+force\_bdss\.mco\.base\_mco\_factory module
+-------------------------------------------
.. automodule:: force_bdss.mco.base_mco_factory
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.base_mco_model module
-------------------------------------
+force\_bdss\.mco\.base\_mco\_model module
+-----------------------------------------
.. automodule:: force_bdss.mco.base_mco_model
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.i_mco_factory module
------------------------------------
+force\_bdss\.mco\.i\_mco\_factory module
+----------------------------------------
.. automodule:: force_bdss.mco.i_mco_factory
:members:
diff --git a/doc/source/api/force_bdss.mco.tests.rst b/doc/source/api/force_bdss.mco.tests.rst
index f1af86e..e20c2d0 100644
--- a/doc/source/api/force_bdss.mco.tests.rst
+++ b/doc/source/api/force_bdss.mco.tests.rst
@@ -1,27 +1,27 @@
-force_bdss.mco.tests package
-============================
+force\_bdss\.mco\.tests package
+===============================
Submodules
----------
-force_bdss.mco.tests.test_base_mco module
------------------------------------------
+force\_bdss\.mco\.tests\.test\_base\_mco module
+-----------------------------------------------
.. automodule:: force_bdss.mco.tests.test_base_mco
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.tests.test_base_mco_communicator module
-------------------------------------------------------
+force\_bdss\.mco\.tests\.test\_base\_mco\_communicator module
+-------------------------------------------------------------
.. automodule:: force_bdss.mco.tests.test_base_mco_communicator
:members:
:undoc-members:
:show-inheritance:
-force_bdss.mco.tests.test_base_mco_factory module
--------------------------------------------------
+force\_bdss\.mco\.tests\.test\_base\_mco\_factory module
+--------------------------------------------------------
.. automodule:: force_bdss.mco.tests.test_base_mco_factory
:members:
diff --git a/doc/source/api/force_bdss.notification_listeners.rst b/doc/source/api/force_bdss.notification_listeners.rst
new file mode 100644
index 0000000..0aae24e
--- /dev/null
+++ b/doc/source/api/force_bdss.notification_listeners.rst
@@ -0,0 +1,46 @@
+force\_bdss\.notification\_listeners package
+============================================
+
+Submodules
+----------
+
+force\_bdss\.notification\_listeners\.base\_notification\_listener module
+-------------------------------------------------------------------------
+
+.. automodule:: force_bdss.notification_listeners.base_notification_listener
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.notification\_listeners\.base\_notification\_listener\_factory module
+----------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.notification_listeners.base_notification_listener_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.notification\_listeners\.base\_notification\_listener\_model module
+--------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.notification_listeners.base_notification_listener_model
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.notification\_listeners\.i\_notification\_listener\_factory module
+-------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.notification_listeners.i_notification_listener_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.notification_listeners
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.rst b/doc/source/api/force_bdss.rst
index bbf6b64..96ca6a7 100644
--- a/doc/source/api/force_bdss.rst
+++ b/doc/source/api/force_bdss.rst
@@ -1,5 +1,5 @@
-force_bdss package
-==================
+force\_bdss package
+===================
Subpackages
-----------
@@ -13,85 +13,94 @@ Subpackages
force_bdss.io
force_bdss.kpi
force_bdss.mco
+ force_bdss.notification_listeners
force_bdss.tests
Submodules
----------
-force_bdss.api module
----------------------
+force\_bdss\.api module
+-----------------------
.. automodule:: force_bdss.api
:members:
:undoc-members:
:show-inheritance:
-force_bdss.base_core_driver module
-----------------------------------
+force\_bdss\.base\_core\_driver module
+--------------------------------------
.. automodule:: force_bdss.base_core_driver
:members:
:undoc-members:
:show-inheritance:
-force_bdss.base_extension_plugin module
----------------------------------------
+force\_bdss\.base\_extension\_plugin module
+-------------------------------------------
.. automodule:: force_bdss.base_extension_plugin
:members:
:undoc-members:
:show-inheritance:
-force_bdss.bdss_application module
-----------------------------------
+force\_bdss\.bdss\_application module
+-------------------------------------
.. automodule:: force_bdss.bdss_application
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_evaluation_driver module
+force\_bdss\.core\_driver\_events module
----------------------------------------
+.. automodule:: force_bdss.core_driver_events
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_evaluation\_driver module
+--------------------------------------------
+
.. automodule:: force_bdss.core_evaluation_driver
:members:
:undoc-members:
:show-inheritance:
-force_bdss.core_mco_driver module
----------------------------------
+force\_bdss\.core\_mco\_driver module
+-------------------------------------
.. automodule:: force_bdss.core_mco_driver
:members:
:undoc-members:
:show-inheritance:
-force_bdss.factory_registry_plugin module
------------------------------------------
+force\_bdss\.factory\_registry\_plugin module
+---------------------------------------------
.. automodule:: force_bdss.factory_registry_plugin
:members:
:undoc-members:
:show-inheritance:
-force_bdss.ids module
----------------------
+force\_bdss\.ids module
+-----------------------
.. automodule:: force_bdss.ids
:members:
:undoc-members:
:show-inheritance:
-force_bdss.local_traits module
-------------------------------
+force\_bdss\.local\_traits module
+---------------------------------
.. automodule:: force_bdss.local_traits
:members:
:undoc-members:
:show-inheritance:
-force_bdss.version module
--------------------------
+force\_bdss\.version module
+---------------------------
.. automodule:: force_bdss.version
:members:
diff --git a/doc/source/api/force_bdss.tests.fixtures.rst b/doc/source/api/force_bdss.tests.fixtures.rst
index 67056f7..3c0c12f 100644
--- a/doc/source/api/force_bdss.tests.fixtures.rst
+++ b/doc/source/api/force_bdss.tests.fixtures.rst
@@ -1,5 +1,5 @@
-force_bdss.tests.fixtures package
-=================================
+force\_bdss\.tests\.fixtures package
+====================================
Module contents
---------------
diff --git a/doc/source/api/force_bdss.tests.rst b/doc/source/api/force_bdss.tests.rst
index b843215..6350da6 100644
--- a/doc/source/api/force_bdss.tests.rst
+++ b/doc/source/api/force_bdss.tests.rst
@@ -1,5 +1,5 @@
-force_bdss.tests package
-========================
+force\_bdss\.tests package
+==========================
Subpackages
-----------
@@ -11,46 +11,62 @@ Subpackages
Submodules
----------
-force_bdss.tests.test_bdss_application module
----------------------------------------------
+force\_bdss\.tests\.test\_bdss\_application module
+--------------------------------------------------
.. automodule:: force_bdss.tests.test_bdss_application
:members:
:undoc-members:
:show-inheritance:
-force_bdss.tests.test_core_evaluation_driver module
----------------------------------------------------
+force\_bdss\.tests\.test\_core\_evaluation\_driver module
+---------------------------------------------------------
.. automodule:: force_bdss.tests.test_core_evaluation_driver
:members:
:undoc-members:
:show-inheritance:
-force_bdss.tests.test_factory_registry_plugin module
-----------------------------------------------------
+force\_bdss\.tests\.test\_core\_mco\_driver module
+--------------------------------------------------
+
+.. automodule:: force_bdss.tests.test_core_mco_driver
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.tests\.test\_factory\_registry\_plugin module
+----------------------------------------------------------
.. automodule:: force_bdss.tests.test_factory_registry_plugin
:members:
:undoc-members:
:show-inheritance:
-force_bdss.tests.test_ids module
---------------------------------
+force\_bdss\.tests\.test\_ids module
+------------------------------------
.. automodule:: force_bdss.tests.test_ids
:members:
:undoc-members:
:show-inheritance:
-force_bdss.tests.test_local_traits module
------------------------------------------
+force\_bdss\.tests\.test\_local\_traits module
+----------------------------------------------
.. automodule:: force_bdss.tests.test_local_traits
:members:
:undoc-members:
:show-inheritance:
+force\_bdss\.tests\.utils module
+--------------------------------
+
+.. automodule:: force_bdss.tests.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
Module contents
---------------
--
GitLab
From ec3bf3086e32373a7147d87e1550115a2de3bee5 Mon Sep 17 00:00:00 2001
From: martinRenou <martin.renou@isae.fr>
Date: Tue, 22 Aug 2017 17:49:07 +0100
Subject: [PATCH 4/5] Update documentation
---
doc/source/design.rst | 7 ++++++-
doc/source/introduction.rst | 3 +++
doc/source/plugin_development.rst | 4 ++--
3 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/doc/source/design.rst b/doc/source/design.rst
index 42edd6c..b14ec9c 100644
--- a/doc/source/design.rst
+++ b/doc/source/design.rst
@@ -1,12 +1,13 @@
Design
------
-The application is based on four entities, as written in the introduction:
+The application is based on five entities, as written in the introduction:
- Multi Criteria Optimizer (MCO)
- DataSources
- Key Performance Indicator (KPI) Calculators
- Notification Listeners
+- UI Hooks
There are a few core assumptions about each of these entities:
@@ -23,6 +24,10 @@ There are a few core assumptions about each of these entities:
of the computation/Finished). It can be a remote database which is filled
with the MCO results during the computation (e.g. the GUI ``force_wfmanager``
has a notification listener in order to fill the result table).
+- UI Hooks permit to define additional operations which will be executed
+ at specific moments in the UI lifetime (before and after exectution of the
+ bdss, before saving the workflow). Those operations won't be executed by the
+ command line interface of the bdss.
The result can be represented with the following data flow
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 9d676ac..1af0605 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -15,6 +15,9 @@ API to provide new entities, specifically:
- Key Performance Indicator (KPI) Calculators
- Notification Listeners, like a remote database which retrieve data during the
computation
+- UI Hooks, which permit to define additional operations which will be executed
+ at specific moments in the UI lifetime (before and after exectution of the
+ bdss, before saving the workflow)
Plugin support requires compliancy to the Force BDSS api for plugins.
Extensions are registered via setuptools entry points.
diff --git a/doc/source/plugin_development.rst b/doc/source/plugin_development.rst
index 3b50823..b8b7332 100644
--- a/doc/source/plugin_development.rst
+++ b/doc/source/plugin_development.rst
@@ -1,8 +1,8 @@
Plugin Development
------------------
-A single Plugin can provide one or more of the pluggable entities
-described elsewhere (MCO/KPICalculators/DataSources/NotificationListeners).
+A single Plugin can provide one or more of the pluggable entities described
+elsewhere (MCO/KPICalculators/DataSources/NotificationListeners/UIHooks).
Multiple plugins can be installed to provide a broad range of functionalities.
Plugins must return Factories. Each Factory provides factory methods for
--
GitLab
From 9e51188b4efcf47920444c7fcc5ff874a64da895 Mon Sep 17 00:00:00 2001
From: martinRenou <martin.renou@isae.fr>
Date: Tue, 22 Aug 2017 17:49:44 +0100
Subject: [PATCH 5/5] Make apidoc
---
...dss.core_plugins.dummy.power_evaluator.rst | 45 +++++++++++++++++++
...re_plugins.dummy.power_evaluator.tests.rst | 30 +++++++++++++
.../api/force_bdss.core_plugins.dummy.rst | 1 +
doc/source/api/force_bdss.rst | 1 +
doc/source/api/force_bdss.ui_hooks.rst | 45 +++++++++++++++++++
doc/source/api/force_bdss.ui_hooks.tests.rst | 30 +++++++++++++
6 files changed, 152 insertions(+)
create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.rst
create mode 100644 doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.tests.rst
create mode 100644 doc/source/api/force_bdss.ui_hooks.rst
create mode 100644 doc/source/api/force_bdss.ui_hooks.tests.rst
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.rst b/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.rst
new file mode 100644
index 0000000..6313c00
--- /dev/null
+++ b/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.rst
@@ -0,0 +1,45 @@
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator package
+===========================================================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ force_bdss.core_plugins.dummy.power_evaluator.tests
+
+Submodules
+----------
+
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_data\_source module
+------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_data_source
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_factory module
+-------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.power\_evaluator\_model module
+-----------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.power_evaluator_model
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.tests.rst b/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.tests.rst
new file mode 100644
index 0000000..51a90e8
--- /dev/null
+++ b/doc/source/api/force_bdss.core_plugins.dummy.power_evaluator.tests.rst
@@ -0,0 +1,30 @@
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests package
+==================================================================
+
+Submodules
+----------
+
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests\.test\_power\_evaluator\_data\_source module
+-------------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests.test_power_evaluator_data_source
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.core\_plugins\.dummy\.power\_evaluator\.tests\.test\_power\_evaluator\_factory module
+--------------------------------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests.test_power_evaluator_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.core_plugins.dummy.power_evaluator.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.rst b/doc/source/api/force_bdss.core_plugins.dummy.rst
index ae1d819..17e91bf 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.rst
@@ -12,6 +12,7 @@ Subpackages
force_bdss.core_plugins.dummy.dummy_kpi_calculator
force_bdss.core_plugins.dummy.dummy_notification_listener
force_bdss.core_plugins.dummy.kpi_adder
+ force_bdss.core_plugins.dummy.power_evaluator
force_bdss.core_plugins.dummy.tests
Submodules
diff --git a/doc/source/api/force_bdss.rst b/doc/source/api/force_bdss.rst
index 96ca6a7..fbf2323 100644
--- a/doc/source/api/force_bdss.rst
+++ b/doc/source/api/force_bdss.rst
@@ -15,6 +15,7 @@ Subpackages
force_bdss.mco
force_bdss.notification_listeners
force_bdss.tests
+ force_bdss.ui_hooks
Submodules
----------
diff --git a/doc/source/api/force_bdss.ui_hooks.rst b/doc/source/api/force_bdss.ui_hooks.rst
new file mode 100644
index 0000000..309a330
--- /dev/null
+++ b/doc/source/api/force_bdss.ui_hooks.rst
@@ -0,0 +1,45 @@
+force\_bdss\.ui\_hooks package
+==============================
+
+Subpackages
+-----------
+
+.. toctree::
+
+ force_bdss.ui_hooks.tests
+
+Submodules
+----------
+
+force\_bdss\.ui\_hooks\.base\_ui\_hooks\_factory module
+-------------------------------------------------------
+
+.. automodule:: force_bdss.ui_hooks.base_ui_hooks_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.ui\_hooks\.base\_ui\_hooks\_manager module
+-------------------------------------------------------
+
+.. automodule:: force_bdss.ui_hooks.base_ui_hooks_manager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.ui\_hooks\.i\_ui\_hooks\_factory module
+----------------------------------------------------
+
+.. automodule:: force_bdss.ui_hooks.i_ui_hooks_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.ui_hooks
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/source/api/force_bdss.ui_hooks.tests.rst b/doc/source/api/force_bdss.ui_hooks.tests.rst
new file mode 100644
index 0000000..7842a34
--- /dev/null
+++ b/doc/source/api/force_bdss.ui_hooks.tests.rst
@@ -0,0 +1,30 @@
+force\_bdss\.ui\_hooks\.tests package
+=====================================
+
+Submodules
+----------
+
+force\_bdss\.ui\_hooks\.tests\.test\_base\_ui\_hooks\_factory module
+--------------------------------------------------------------------
+
+.. automodule:: force_bdss.ui_hooks.tests.test_base_ui_hooks_factory
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+force\_bdss\.ui\_hooks\.tests\.test\_base\_ui\_hooks\_manager module
+--------------------------------------------------------------------
+
+.. automodule:: force_bdss.ui_hooks.tests.test_base_ui_hooks_manager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: force_bdss.ui_hooks.tests
+ :members:
+ :undoc-members:
+ :show-inheritance:
--
GitLab