.. scamp-ml_uvt documentation master file, created by sphinx-quickstart on Sun Nov 13 12:05:43 2022. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. ``scamp-ml_uvt``: production planning micro-service ===================================================== `scamp-ml_uvt` production planning micro-service enables the retrival of operational data and applies several production scheduling algorithms or quality criterias. Features of ``scamp-ml_uvt`` micro-service: ----------------------------------------------- * process operational information from DB * generate synthetic data for testing purposes * generate a BOM from the operational DB * store the BOM relationships and other properties into a DB * apply production scheduling algorithms and quality criterias * expose production scheduling algorithms and quality criterias using a REST API * graphical visualization of the applied production scheduling algorithms and quality criterias Usage ------------ ``scamp-ml_uvt`` is only available on the private `Gitlab `_. Its main dependencies are `Django `_ and Django REST, all of which should pose no problems to install. The entire dependencies list if provided under ``requirements.txt`` (for `pip`) and a ``environment.yml`` (for `conda`). Running the micro-service is standard to any Django based application. A short description is provided below: **Admin pages** For the case in which there is a need to use the admin pages, one have to create an admin user using the command:: python manage.py createsuperuser From the project root directory. Follow the instructions on the screen. **Run Django Webserver** To queue the program under the Django webserver, queue in the IDE terminal, or in a separate terminal:: python manage.py runserver from the project root. This will start the Django webserver (http://127.0.0.1:8000/) and allow access to the administrative pages. To access the admin pages, go to http://127.0.0.1:8000/admin and use the user and password provided in the previous step. **Run standalone** For running the program standalone, the entry point us located in ``{PROJECT_ROOT}/scamp-ml_uvt/main.py`` file, so:: cd {PROJECT_ROOT}/scamp-ml_uvt/ python main.py This will launch a small program that connects to the database through the existing models and makes a selection of data. This would be the entry point of the app. .. toctree:: :maxdepth: 2 :caption: Contents: api_intro datagen_intro db_intro graphviz_intro modules Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`