diff --git a/.gitignore b/.gitignore
index cd6c60cb88592988944d923da8e803b2b5ef0cfe..8a8bf31765c12959f4326f1d5819e7d71803bc70 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,4 +2,4 @@ __pycache__
*.egg-info
doc/build/
*.pyc
-
+force_bdss/version.py
diff --git a/braindump/datasource.py b/braindump/datasource.py
deleted file mode 100644
index af36fd93db389aec14cb5f1fcc73ddc8be5dac16..0000000000000000000000000000000000000000
--- a/braindump/datasource.py
+++ /dev/null
@@ -1,35 +0,0 @@
-class DataSource():
- """Base class that performs calculation or extraction of information
- """
- __metaclass__ = abc.ABCMeta
-
- def __init__(self, name):
- self.name = name
-
- @abstractclassmethod
- def provides(cls):
- return [CUBA.key]
-
- def execute(self, parameters):
- """Performs the evaluation and returns a list of Result.
- """
-
-
-class Simulator(DataSource):
- pass
-
-
-class Database(DataSource):
- pass
-
-
-# Represents the result of a simulator.
-# It contains the resulting cuba key, the associated uncertainty and the
-# originating simulator.
-# Difference between uncertainty and quality: uncertainty is a numerical value
-# of the value, as in the case of an experimental simulation.
-# quality is the level of accuracy of the (e.g.c omputational) method, as
-# the importance and reliability of that value. It should be an enumeration
-# value such as HIGH, MEDIUM, POOR
-Result = namedtuple("Result", "cuba_key value uncertainty originator quality")
-
diff --git a/braindump/kpi_calculator.py b/braindump/kpi_calculator.py
deleted file mode 100644
index d9e7d0d60dfca89fdddc98861f21c65323bea6e6..0000000000000000000000000000000000000000
--- a/braindump/kpi_calculator.py
+++ /dev/null
@@ -1,16 +0,0 @@
-class KPICalculator():
- """Base class that defines the equaation to compute the KPIs values from
- the results of the simulators
-
- input: a list of SimulatorResult
- output: a list of KPIs.
- """
- __metaclass__ = abc.ABCMeta
-
- def execute(self, datasource_results)
- """Returns the KPIResult"""
-
-
-KPIResult = namedtuple("KPIResult", "name cuba_key value uncertainty quality")
-
-
diff --git a/braindump/main.py b/braindump/main.py
deleted file mode 100644
index a61d6a00c4e4b9534c8375c5ecdf4fa738d95930..0000000000000000000000000000000000000000
--- a/braindump/main.py
+++ /dev/null
@@ -1,38 +0,0 @@
-from force_bdss import *
-
-wf=Workflow()
-wf.set_mco(Dakota())
-wf.set_datasources([
- ViscositySimulator(),
- CostExtractor(),
-])
-wf.objectives([
- Objective(),
- Objective()
- ])
-
-
-wf.set_parameters({
- "material_1": {
- CUBA.FORMULA: "H2O",
- CUBA.CONCENTRATION: Range(0, 100)
- },
- "material_2": {
- CUBA.FORMULA: "glycol",
- CUBA.CONCENTRATION: Formula("material_1",
- lambda material_1: 100 - material_1[CUBA.CONCENTRATION])
- }
-})
-
-wf.set_result_callback(callback)
-
-# constraints vs computed value
-# e.g. constraint = value from 0 to 100
-# computed value = 100 - other value
-# TODO: Study dakota better to understand how it works and what kind of
-# interface it expects
-
-pareto_front = wf.execute()
-
-plot(pareto_front)
-
diff --git a/braindump/mco.py b/braindump/mco.py
deleted file mode 100644
index 6b4756219dc167fba02d2b01653fd45dd323064d..0000000000000000000000000000000000000000
--- a/braindump/mco.py
+++ /dev/null
@@ -1,26 +0,0 @@
-class MCO():
- """Receives a list of KPIResult to decide the next step in the parameter
- space"""
- __metaclass__ = abc.ABCMeta
- starting_point
- variable_constraints
- objectives
-
- def get_next_parameters(kpi_results):
- pass
-
-
-class Dakota(MCO):
- def __init__(self, options):
- pass
-
-
-class DakotaInput():
- """Read the parameters from the dakota input file and returns
- the parameters for further consumption"""
- def parse(filename):
- """Returns the parameters"""
-
-
-class DakotaOutput():
- """Writes the KPIs to the file for consumption by Dakota"""
diff --git a/braindump/workflow.py b/braindump/workflow.py
deleted file mode 100644
index 70c268a0b1ee2518fcbbed3a7c9cc602280c2914..0000000000000000000000000000000000000000
--- a/braindump/workflow.py
+++ /dev/null
@@ -1,25 +0,0 @@
-# This is a prototype for the Workflow in FORCE
-import abc
-
-
-class Workflow():
- # calculates the KPIs from the list of the cuba keys coming from the
- # simulators
- mco = None
- data_sources = None
-
-
-
-
-class ViscosityCalculator(Simulator):
- pass
-
-
-class CostExtractor(Database):
- provides_kpi = []
-
-
-class Objective()
- kpi = None
- optimization_type = MAXIMIZE
-
diff --git a/doc/source/api/force_bdss.cli.rst b/doc/source/api/force_bdss.cli.rst
index c6f155feae77f2f4ef9f45341a29ee927b931f5e..c96292e6712e3cb76369b1c4c59ddfe58c7c3e3f 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 207d9516f942c774bf349ac8a91ec55c4f5807ca..5fef4d6bb9516d1e822af0255e1b311b0b77ea98 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_plugins.dummy.csv_extractor.rst b/doc/source/api/force_bdss.core_plugins.dummy.csv_extractor.rst
index 9ae598589c9d83a01f695595f72b5065774f8ce1..0db16a6675b7671c06903351b160229e47566b3b 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\_bundle module
---------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_bundle module
+-----------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.csv_extractor_bundle
:members:
:undoc-members:
:show-inheritance:
-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\_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 95ab6ce85eadac258e92d3e68dcd65ced13d2c6a..a93a5fc4096ee9a1fedeb5c2141b40e22456bcd3 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\_bundle module
----------------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_bundle module
+----------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.csv_extractor.tests.test_csv_extractor_bundle
:members:
:undoc-members:
:show-inheritance:
-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:
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 9ddaee43284dbe56e934bebb16764fedecda5d81..61c462f5e1b6dcf940904290845e913f67c73fbf 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,32 +11,32 @@ Subpackages
Submodules
----------
-force\_bdss\.core\_plugins\.dummy\.dummy\_dakota\.dakota\_bundle module
------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_dakota.dakota_bundle module
+---------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.dakota_bundle
:members:
:undoc-members:
:show-inheritance:
-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\_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:
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 0e5975a08327f16be2155c9f947abeba04c6f669..febc1cb487e5b89984ef0c82d5aadd2e7cd5058b 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,25 +1,33 @@
-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\_bundle module
-------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_bundle module
+--------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_bundle
:members:
:undoc-members:
:show-inheritance:
-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_optimizer module
+-----------------------------------------------------------------------------
+
+.. automodule:: force_bdss.core_plugins.dummy.dummy_dakota.tests.test_dakota_optimizer
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
Module contents
---------------
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 da0f4ed38f1eafcdf6736cf1ffa7f3f736638b12..f6b31d3bbaf5a90a1f95755423a1d36931a5d168 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\_bundle module
-------------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_bundle module
+-------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.dummy_data_source_bundle
: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 a665a03f64f2c6d9d8011de225f1f9b8f05e7407..84c724a0bce909180744f3812a3617e28a318f56 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\_bundle module
--------------------------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_bundle module
+------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_data_source.tests.test_dummy_data_source_bundle
: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 5de1ecc908401be6fd36aedf61edafaa5cff6ea3..c02d6eeef6e62d171fcccee196f8d65bc9dfc1a3 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\_bundle module
-------------------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_bundle module
+-------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.dummy_kpi_calculator_bundle
: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 bf54bf5ede11330a2fc4bde99898cf22fc106e4b..f46cc8792a1b4bb891bef1cbf7162a64f1b64473 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,11 +1,11 @@
-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\_bundle module
--------------------------------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_bundle module
+------------------------------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.dummy_kpi_calculator.tests.test_dummy_kpi_calculator_bundle
:members:
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 ea4c2baf13eabbd5002ecbfd44d70aabac359fd5..e50d5f5412539c27e21d7a476823ff9408d26987 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\_bundle module
-------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_bundle module
+---------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.kpi_adder_bundle
:members:
:undoc-members:
:show-inheritance:
-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\_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 3937a7e155466d0c7e370c0ae4edaa0ea468dcb7..1aa848c9f7c5b75123f4dc1408a0124a40555ca2 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,11 +1,11 @@
-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\_bundle module
--------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_bundle module
+--------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.kpi_adder.tests.test_kpi_adder_bundle
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.dummy.rst b/doc/source/api/force_bdss.core_plugins.dummy.rst
index 82b8d0273381e6db869689d1cdcc659bf260da2c..6d5b57bb89bf098067e01e605e684565990e3151 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
-----------
@@ -16,8 +16,8 @@ Subpackages
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 fbe318ae3b065e37dbcdfef4a6e2fe426183c0a7..b20750e59689a67817f4bade9d9b5cca503aa9af 100644
--- a/doc/source/api/force_bdss.core_plugins.dummy.tests.rst
+++ b/doc/source/api/force_bdss.core_plugins.dummy.tests.rst
@@ -1,19 +1,19 @@
-force\_bdss\.core\_plugins\.dummy\.tests package
-================================================
+force_bdss.core_plugins.dummy.tests package
+===========================================
Submodules
----------
-force\_bdss\.core\_plugins\.dummy\.tests\.data\_source\_bundle\_test\_mixin module
-----------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.tests.data_source_bundle_test_mixin module
+------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.data_source_bundle_test_mixin
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.core\_plugins\.dummy\.tests\.kpi\_calculator\_bundle\_test\_mixin module
--------------------------------------------------------------------------------------
+force_bdss.core_plugins.dummy.tests.kpi_calculator_bundle_test_mixin module
+---------------------------------------------------------------------------
.. automodule:: force_bdss.core_plugins.dummy.tests.kpi_calculator_bundle_test_mixin
:members:
diff --git a/doc/source/api/force_bdss.core_plugins.rst b/doc/source/api/force_bdss.core_plugins.rst
index d667de4d88ad1e3f3b4ee21977731d9091daad0b..aabfada58813a84466b0ca4252d7d6277ad032df 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 e5548091c1a73ff48d22001ed95eab727ddfb154..7df2d7d82a4fc847ade8719b3c338e4fb4c3b04c 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,48 +11,48 @@ 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\_bundle module
--------------------------------------------------------------
+force_bdss.data_sources.base_data_source_bundle module
+------------------------------------------------------
.. automodule:: force_bdss.data_sources.base_data_source_bundle
: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\.data\_source\_parameters module
------------------------------------------------------------
+force_bdss.data_sources.data_source_parameters module
+-----------------------------------------------------
.. automodule:: force_bdss.data_sources.data_source_parameters
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.data\_sources\.data\_source\_result module
--------------------------------------------------------
+force_bdss.data_sources.data_source_result module
+-------------------------------------------------
.. automodule:: force_bdss.data_sources.data_source_result
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.data\_sources\.i\_data\_source\_bundle module
-----------------------------------------------------------
+force_bdss.data_sources.i_data_source_bundle module
+---------------------------------------------------
.. automodule:: force_bdss.data_sources.i_data_source_bundle
:members:
diff --git a/doc/source/api/force_bdss.data_sources.tests.rst b/doc/source/api/force_bdss.data_sources.tests.rst
index 2b9563c0d99b6b04af56263f10eb83e968312357..067997cbdb5e09e2db0e7b93d0aa7f87d3082e40 100644
--- a/doc/source/api/force_bdss.data_sources.tests.rst
+++ b/doc/source/api/force_bdss.data_sources.tests.rst
@@ -1,19 +1,19 @@
-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\_bundle module
---------------------------------------------------------------------------
+force_bdss.data_sources.tests.test_base_data_source_bundle module
+-----------------------------------------------------------------
.. automodule:: force_bdss.data_sources.tests.test_base_data_source_bundle
:members:
diff --git a/doc/source/api/force_bdss.io.rst b/doc/source/api/force_bdss.io.rst
index 558ecbe7027e6a1f7dac11c92b973a6c3111e9f3..c221828e07ac581f86f7948193842a228c018dca 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 7a53ccef1f9275f7ef794f7d0fe3d73f45445cef..d7512c8f927552c173fa291b1f2958b696207c95 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 c8c9a36153b11d6b8717c93cebc22f53675d1b0d..b90b1b5f07e1e7e428de41c12bfe88cb58abd4c6 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,40 +11,40 @@ 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\_bundle module
-------------------------------------------------------
+force_bdss.kpi.base_kpi_calculator_bundle module
+------------------------------------------------
.. automodule:: force_bdss.kpi.base_kpi_calculator_bundle
: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\_bundle module
----------------------------------------------------
+force_bdss.kpi.i_kpi_calculator_bundle module
+---------------------------------------------
.. automodule:: force_bdss.kpi.i_kpi_calculator_bundle
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.kpi\.kpi\_calculator\_result module
-------------------------------------------------
+force_bdss.kpi.kpi_calculator_result module
+-------------------------------------------
.. automodule:: force_bdss.kpi.kpi_calculator_result
:members:
diff --git a/doc/source/api/force_bdss.kpi.tests.rst b/doc/source/api/force_bdss.kpi.tests.rst
index e7a8126e235c8bac7bea84d12d09fc828949f4cf..9c7eb6c4e91b36ebafe7b82c5da3f3dfa08efb20 100644
--- a/doc/source/api/force_bdss.kpi.tests.rst
+++ b/doc/source/api/force_bdss.kpi.tests.rst
@@ -1,19 +1,19 @@
-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\_bundle module
--------------------------------------------------------------------
+force_bdss.kpi.tests.test_base_kpi_calculator_bundle module
+-----------------------------------------------------------
.. automodule:: force_bdss.kpi.tests.test_base_kpi_calculator_bundle
:members:
diff --git a/doc/source/api/force_bdss.mco.parameters.rst b/doc/source/api/force_bdss.mco.parameters.rst
index 8bad9d2826fe41a48d1a6d9fec4562cb24aeaff1..f289f438bb64123f0dff84ac4d30be8e342d72db 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,32 +11,32 @@ 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:
:undoc-members:
:show-inheritance:
-force\_bdss\.mco\.parameters\.core\_mco\_parameters module
-----------------------------------------------------------
+force_bdss.mco.parameters.core_mco_parameters module
+----------------------------------------------------
.. automodule:: force_bdss.mco.parameters.core_mco_parameters
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.mco\.parameters\.mco\_parameter\_factory\_registry module
-----------------------------------------------------------------------
+force_bdss.mco.parameters.mco_parameter_factory_registry module
+---------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.mco_parameter_factory_registry
:members:
diff --git a/doc/source/api/force_bdss.mco.parameters.tests.rst b/doc/source/api/force_bdss.mco.parameters.tests.rst
index c8950c209dce89f496fed6cff8448b59c7a427db..694cb158a833bfa1c3860bf12166bd71ab93788a 100644
--- a/doc/source/api/force_bdss.mco.parameters.tests.rst
+++ b/doc/source/api/force_bdss.mco.parameters.tests.rst
@@ -1,35 +1,35 @@
-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:
:undoc-members:
:show-inheritance:
-force\_bdss\.mco\.parameters\.tests\.test\_core\_mco\_parameters module
------------------------------------------------------------------------
+force_bdss.mco.parameters.tests.test_core_mco_parameters module
+---------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.tests.test_core_mco_parameters
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.mco\.parameters\.tests\.test\_parameter\_factory\_registry module
-------------------------------------------------------------------------------
+force_bdss.mco.parameters.tests.test_parameter_factory_registry module
+----------------------------------------------------------------------
.. automodule:: force_bdss.mco.parameters.tests.test_parameter_factory_registry
:members:
diff --git a/doc/source/api/force_bdss.mco.rst b/doc/source/api/force_bdss.mco.rst
index ced0270689b083d478226aafd1faadbaf4cc7948..c8047b33691b51c57d8f3ac75629b1c6f206f8ff 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\_bundle module
-------------------------------------------
+force_bdss.mco.base_mco_bundle module
+-------------------------------------
.. automodule:: force_bdss.mco.base_mco_bundle
: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\_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\_bundle module
----------------------------------------
+force_bdss.mco.i_mco_bundle module
+----------------------------------
.. automodule:: force_bdss.mco.i_mco_bundle
:members:
diff --git a/doc/source/api/force_bdss.mco.tests.rst b/doc/source/api/force_bdss.mco.tests.rst
index 809ef692cabc2a883cb72b24e72b381c4eda9519..6dbcf8432a56e54097c8d928f481e2ee23fed06b 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\_bundle module
--------------------------------------------------------
+force_bdss.mco.tests.test_base_mco_bundle module
+------------------------------------------------
.. automodule:: force_bdss.mco.tests.test_base_mco_bundle
: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:
diff --git a/doc/source/api/force_bdss.rst b/doc/source/api/force_bdss.rst
index 63a788a84fc979af8c0189b1a01fd682fde7b8b8..e558a1c921e3a3b557f6ccb205fb8f9349659589 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
-----------
@@ -18,70 +18,78 @@ Subpackages
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\.bundle\_registry\_plugin module
---------------------------------------------
+force_bdss.bundle_registry_plugin module
+----------------------------------------
.. automodule:: force_bdss.bundle_registry_plugin
:members:
:undoc-members:
:show-inheritance:
-force\_bdss\.core\_evaluation\_driver module
---------------------------------------------
+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\.ids module
------------------------
+force_bdss.ids module
+---------------------
.. automodule:: force_bdss.ids
:members:
:undoc-members:
:show-inheritance:
+force_bdss.version module
+-------------------------
+
+.. automodule:: force_bdss.version
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
Module contents
---------------
diff --git a/doc/source/api/force_bdss.tests.fixtures.rst b/doc/source/api/force_bdss.tests.fixtures.rst
index 3c0c12f86492d2ad5aec4a1d6e1753da47ba1084..67056f7ef65941c819e17e7abbf4756b4b11728a 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 4402dd7deb447dbdc03b33327328e839dc5fc3e2..3f6641aec683b4a9df907c93aed68093123e0b50 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,32 +11,32 @@ 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\_bundle\_registry\_plugin module
----------------------------------------------------------
+force_bdss.tests.test_bundle_registry_plugin module
+---------------------------------------------------
.. automodule:: force_bdss.tests.test_bundle_registry_plugin
: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\_ids module
-------------------------------------
+force_bdss.tests.test_ids module
+--------------------------------
.. automodule:: force_bdss.tests.test_ids
:members:
diff --git a/doc/source/api/force_bdss.workspecs.rst b/doc/source/api/force_bdss.workspecs.rst
index d83f60e920cdaab28713ba0d8e036fe7db30fa13..13fb1dc84f6905f6ae3cbdbb78d4ad0b48fd4c5a 100644
--- a/doc/source/api/force_bdss.workspecs.rst
+++ b/doc/source/api/force_bdss.workspecs.rst
@@ -1,11 +1,11 @@
-force\_bdss\.workspecs package
-==============================
+force_bdss.workspecs package
+============================
Submodules
----------
-force\_bdss\.workspecs\.workflow module
----------------------------------------
+force_bdss.workspecs.workflow module
+------------------------------------
.. automodule:: force_bdss.workspecs.workflow
:members:
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 289f4699b729bf603e2e8449e66939191a6991d9..942d1f0f9a6dae14afd8e3f101a243278ecb770d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -9,7 +9,9 @@ import os
sys.path.insert(0, os.path.join(
os.path.dirname(os.path.abspath(__file__)), "..", "..")
)
-print(sys.path)
+
+from force_bdss.version import __version__ as RELEASE
+
MOCK_MODULES=[]
def _warn_node(self, msg, node, **kwargs):
@@ -58,8 +60,8 @@ source_suffix = '.rst'
master_doc = 'index'
project = u'FORCE'
copyright = u'2017, FORCE Project'
-version = '0.1.0'
-release = '0.1.0.dev0'
+version = ".".join(RELEASE.split(".")[0:3])
+release = RELEASE
pygments_style = 'sphinx'
html_theme = 'classic'
html_static_path = ['_static']
diff --git a/doc/source/design.rst b/doc/source/design.rst
new file mode 100644
index 0000000000000000000000000000000000000000..574edbf630d53b0541251535d9e5208d7ba62ddf
--- /dev/null
+++ b/doc/source/design.rst
@@ -0,0 +1,37 @@
+Design
+------
+
+The application is based on three entities, as written in the introduction:
+
+- Multi Criteria Optimizer (MCO)
+- DataSources
+- Key Performance Indicator (KPI) Calculators
+
+There are a few core assumptions about each of these entities:
+
+- The MCO design must honor the execution model of Dakota, that is, spawn
+ a secondary process that performs a computation starting from a given set
+ of input parameters, and produces a resulting set of output parameters.
+ In our code, this secondary process is ``force_bdss`` itself, invoked with
+ the option ``--evaluate``.
+- The DataSources are entities that, given the MCO parameters, provide some
+ 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 result can be represented with the following data flow
+
+
+1. The MCO produces and, by means of a Communicator, injects...
+2. ...DataSourceParameters, that are passed to...
+3. one or more DataSources, each performing some computation or data
+ extraction and produces
+4. DataSourceResult, one per DataSource, are then passed (together with the
+ DataSourceParameters) to...
+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.
+
+The resulting pipeline is therefore just two layers (DataSources, then
+KPICalculators).
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 2c604ad0e31baae9effe30724964b4e18244c5e1..467b4ca39d68e477b4a57f4f7f20188f44b4a1e5 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,6 +10,8 @@ User Manual
:maxdepth: 1
Introduction <introduction>
+ Design <design>
+ Plugin development <plugin_development>
API Reference
diff --git a/doc/source/introduction.rst b/doc/source/introduction.rst
index 1914d9dc1f45c5e83ba16f087f858eecc2414463..70d16fe0d02d1acd48902d2ba7ae5ff837b532a9 100644
--- a/doc/source/introduction.rst
+++ b/doc/source/introduction.rst
@@ -1,2 +1,23 @@
Introduction
------------
+
+The Business Decision System is the CLI support for the evaluation of
+Pareto front computations. It is a single executable ``force_bdss`` that
+interprets a workflow specification file, normally generated via the GUI
+workflow manager.
+
+By itself, the executable and the code implementing it provides no
+functionality. All functionality comes from external plugins, extending the
+API to provide new entities, specifically:
+
+- Multi Criteria Optimizer (MCO)
+- DataSources
+- Key Performance Indicator (KPI) Calculators
+
+Plugin support requires compliancy to the Force BDSS api for plugins.
+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
new file mode 100644
index 0000000000000000000000000000000000000000..231161baa9bca63d69ca55868abd8f40805e4173
--- /dev/null
+++ b/doc/source/plugin_development.rst
@@ -0,0 +1,25 @@
+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.
+
+Plugins must return "Bundles". Each Bundle acts as a Factory, providing
+factory methods for one of the above pluggable entities and its associated
+classes.
+
+To implement a new plugin, you must
+
+- define the entity you want to extend (e.g. ``MyOwnDataSource``) as a derived
+ class of the appropriate class (e.g. BaseDataSource), and reimplement
+ the appropriate methods.
+- Define the model that this DataSource needs, by extending
+ ``BaseDataSourceModel`` and adding, with traits, the appropriate data that
+ are required by your data source to perform its task.
+- Define the Bundle, by reimplementing BaseDataSourceBundle and reimplementing
+ its ``create_*`` methods to return the above entities.
+- Define a ``Plugin`` by reimplementing ``BaseExtensionPlugin`` and
+ reimplementing its initialization defaults methods to return your bundle.
+- add the plugin class in the setup.py entry_point, under the namespace
+ ``force.bdss.extensions``
diff --git a/setup.py b/setup.py
index 9429bc9b5ec0fb1080280e1eedd00be192c07a95..c0842ae3490fb2a5dc566ad621e7539f600185c9 100644
--- a/setup.py
+++ b/setup.py
@@ -1,6 +1,25 @@
+import os
from setuptools import setup, find_packages
-VERSION = "0.1.0.dev1"
+VERSION = "0.1.0.dev2"
+
+
+# Read description
+with open('README.rst', 'r') as readme:
+ README_TEXT = readme.read()
+
+
+def write_version_py():
+ filename = os.path.join(
+ os.path.dirname(__file__),
+ 'force_bdss',
+ 'version.py')
+ ver = "__version__ = '{}'\n"
+ with open(filename, 'w') as fh:
+ fh.write(ver.format(VERSION))
+
+
+write_version_py()
setup(
name="force_bdss",