Skip to content

README_GENERATED.md

Latest commit

 

History

History
245 lines (207 loc) · 15.8 KB

README_GENERATED.md

File metadata and controls

245 lines (207 loc) · 15.8 KB
Raw

touroptimizer-py-client

This is DNA's JOpt.TourOptimizer service. A RESTful Spring Boot application using springdoc-openapi and OpenAPI 3. JOpt.TourOpptimizer is a service that delivers route optimization and automatic scheduling features to be easily integrated into any third-party application. JOpt.TourOpptimizer encapsulates all necessary optimization functionality and provides a comprehensive REST API that offers a domain-specific optimization interface for the transportation industry. The service is stateless and does not come with graphical user interfaces, map depiction or any databases. These extensions and adjustments are supposed to be introduced by the consumer of the service while integrating it into his/her own application. The service will allow for many suitable adjustments and user-specific settings to adjust the behaviour and optimization goals (e.g. minimizing distance, maximizing resource utilization, etc.) through a comprehensive set of functions. This will enable you to gain control of the complete optimization processes.This service is based on JOpt (null)

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.2.6-SNAPSHOT
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://dna-evolutions.com

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import touroptimizer_py_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import touroptimizer_py_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import touroptimizer_py_client
from touroptimizer_py_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = touroptimizer_py_client.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with touroptimizer_py_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = touroptimizer_py_client.OptimizationFAFServiceControllerApi(api_client)
    rest_optimization = touroptimizer_py_client.RestOptimization() # RestOptimization | 

    try:
        # Provide an optimization and let JOpt solve it.
        api_response = api_instance.run_faf(rest_optimization)
        print("The response of OptimizationFAFServiceControllerApi->run_faf:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling OptimizationFAFServiceControllerApi->run_faf: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
OptimizationFAFServiceControllerApi run_faf POST /api/optimizefaf/runFAF Provide an optimization and let JOpt solve it.
OptimizationFAFServiceControllerApi run_only_result_faf POST /api/optimizefaf/runOnlyResultFAF
OptimizationHealthControllerApi health_status GET /healthStatus Get the health status of this endpoint.
OptimizationServiceControllerApi error GET /api/optimize/stream/error Stream of error. During the optimization run you can obtain optimization errors in percentage by subscribing to this stream
OptimizationServiceControllerApi progress GET /api/optimize/stream/progress Stream of progress. During the optimization run you can obtain the optimization progress in percentage and other useful information about the optimization progress by subscribing to this stream
OptimizationServiceControllerApi run POST /api/optimize/run Provide an optimization and let JOpt solve it.
OptimizationServiceControllerApi run_only_result POST /api/optimize/runOnlyResult Provide an optimization and let JOpt solve it. You only get back the result
OptimizationServiceControllerApi run_started_sginal GET /api/optimize/startedSginal Emmits once an optimization started
OptimizationServiceControllerApi status GET /api/optimize/stream/status Stream of status messages. During the optimization run you can obtain the optimization status by subscribing to this stream
OptimizationServiceControllerApi stop_optimization_run POST /api/optimize/stop This entrypoint stops the optimization gracefully.
OptimizationServiceControllerApi warning GET /api/optimize/stream/warning Stream of warning messages. During the optimization run you can obtain optimization warnings by subscribing to this stream
ReadDatabaseEncryptedServiceControllerApi find_encrypted_optimization POST /api/db/read/findEncryptedOptimization Find encrypted optimizations by id and creator. Only works, if connected to a database.
ReadDatabaseEncryptedServiceControllerApi find_encrypted_solution POST /api/db/read/findEncryptedSolution Find encrypted solutions by id and creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_error POST /api/db/read/findError Find error by creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_optimization POST /api/db/read/findOptimization Find optimizations by creator and id. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_progress POST /api/db/read/findProgress Find progress by creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_solution POST /api/db/read/findSolution Find solutions by creator and id. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_status POST /api/db/read/findStatus Find status by creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi find_warning POST /api/db/read/findWarning Find warning by creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi finds_optimization_infos POST /api/db/read/findsOptimizationInfos Find optimization-infos by creator. Only works, if connected to a database.
ReadDatabaseServiceControllerApi finds_solution_infos POST /api/db/read/findsSolutionInfos Find solution-infos by creator. Only works, if connected to a database.
HealthStatusApi health_status GET /healthStatus Get the health status of this endpoint.
OptimizationApi run POST /api/optimize/run Provide an optimization and let JOpt solve it.
OptimizationApi run_only_result POST /api/optimize/runOnlyResult Provide an optimization and let JOpt solve it. You only get back the result
OptimizationApi stop_optimization_run POST /api/optimize/stop This entrypoint stops the optimization gracefully.
OptimizationFAFApi run_faf POST /api/optimizefaf/runFAF Provide an optimization and let JOpt solve it.
OptimizationFAFApi run_only_result_faf POST /api/optimizefaf/runOnlyResultFAF
StreamApi error GET /api/optimize/stream/error Stream of error. During the optimization run you can obtain optimization errors in percentage by subscribing to this stream
StreamApi progress GET /api/optimize/stream/progress Stream of progress. During the optimization run you can obtain the optimization progress in percentage and other useful information about the optimization progress by subscribing to this stream
StreamApi status GET /api/optimize/stream/status Stream of status messages. During the optimization run you can obtain the optimization status by subscribing to this stream
StreamApi warning GET /api/optimize/stream/warning Stream of warning messages. During the optimization run you can obtain optimization warnings by subscribing to this stream

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

info@dna-evolutions.com