The Decision Maximizer 3000, also known as decision-maximizer or DM3K for short, is a generalized decision-engine that solves complex resource allocation problems.

Table of Contents:

• Installation
  • Pre-Requisites
  • Installation Procedure
• Usage
• Contributing
• License

NOTE - For more explanation of resource allocation problems and their component parts, see /docs/resource_allocation_101.md

DM3K provides the user with:

• a web-based UI to define their resource allocation problem.
• a python optimizer that leverages linear optimization techniques to solve the user defined problem.

Installation assumes you have...

• docker (v19.03+) see https://docs.docker.com/get-docker/
• docker-compose (v1.27+) see https://docs.docker.com/compose/install/

from the main directory of the repo run...

$ sudo docker-compose -f docker-compose.yml up --build -d

NOTE this make take a while....please be patient

To confirm the installation, run...

$ sudo docker ps

Output of this command should show 3 docker containers: dm3k_api, dm3k_ui, dm3k_nginx as shown below...

To confirm the health of the optimizer, run the following command:

$ sudo docker exec -ti dm3k_api python -m unittest discover -v -s /app/tests/test_optimizer

If there are errors, here are some logs to check

$ docker logs <container_name>
$ docker exec -ti dm3k_api cat /app/logs/basic.log

To stop DM3K, run...

$ sudo docker-compose -f docker-compose.yml down

Connect to the UI by pointing your web browser to: http://{hostname}

where hostname is the name or ip address of the machine that is running docker.

For details on how to use the UI to create/solve resource allocation problems see /docs/user_guide.md

See

• CONTRIBUTING
• /docs/dev_env.md or
• /docs/api_devGuide.md or
• /docs/optimizer_devGuide.md

depending on how you wish to contribute.

For more details, see LICENSE file