KevinFasusi / supplychainpy

Supplychainpy is a Python library for supply chain analysis, modelling and simulation. The library assists a workflow that is reliant on Excel and VBA.
http://www.supplychainpy.org/
BSD 3-Clause "New" or "Revised" License
290 stars 100 forks source link

Add public API for Recommendations #49

Open KevinFasusi opened 7 years ago

KevinFasusi commented 7 years ago

Objective

Add a public API for the recommendations feature.

Guidance

Using the recommendations feature, add a public API to model_decisions.py. Allow the function to use run_sku_recommendation() and run_profile_recommendation().

For example:

def recommend( type: str, analysed_data: UncertainDemand, forecast: dict)
    if type == 'sku':
        run_sku_recommendation()
    else:
        run_profile_recommendation()
   return recommendation

However, do not use strings in the conditional statement. You probably don't even need to use a conditional statement.

Please remember to add a docstring and a test for this API.