README (New)

Project CodeStorm

In order to successfully clone and execute the project setup, please navigate through the following steps:

System Requirements

Operating Systems

* Microsoft Windows 10 64-bit: Pro, Enterprise, or Education (Build 15063 or later).
          OR
* Latest version of Apple Mac Operating System

Getting Started

* ### Docker
  * Installation guide for Windows:
    [Docker Installation for Windows Operating System](https://docs.docker.com/docker-for-windows/install/)
  * Installation guide for Mac:
    [Docker Installation for Mac Operating System](https://docs.docker.com/docker-for-mac/release-notes/)
* ### Confluent Kafka (Using Docker)
  * Setup the Confluent Kafka using Docker
    [Confluent Kafka using Docker](https://docs.confluent.io/current/installation/docker/installation/index.html)
* ### Python Flask
  * [Link for Python Flask Installation](https://flask.palletsprojects.com/en/1.1.x/installation/)
  * The Python Flask Module needs to be installed for 3 micro-services namely Data Retrieval, Model Execution & Post- Processing
  * Navigate to the root directory of each and every above-mentioned micro-services and follow the installation guide
    as mentioned in the URL.
  * Install Python Flask using the command pip3 install flask
* ### Micro-service specific libraries
  * The following are the Micro-service specific dependencies. Put these in the requirements.txt for the corresponding
    micro-service and execute the command 'run requirements.txt'
  * ### Data Retrieval
    The following dependencies need to be installed for the Data Retrieval Micro-service
      appdirs==1.4.3
      arm-pyart==1.11.0
      certifi==2019.11.28
      cftime==1.0.4.2
      chardet==3.0.4
      Click==7.0
      confluent-kafka==1.3.0
      cycler==0.10.0
      distlib==0.3.0
      filelock==3.0.12
      Flask==1.1.1
      Flask-Cors==3.0.8
      Flask-Script==2.0.6
      idna==2.8
      imgurpython==1.1.7
      importlib-metadata==1.5.0
      itsdangerous==1.1.0
      Jinja2==2.11.1
      kiwisolver==1.1.0
      MarkupSafe==1.1.1
      matplotlib==3.1.3
      netCDF4==1.5.3
      numpy==1.18.1
      pandas==1.0.1
      pyparsing==2.4.6
      python-dateutil==2.8.1
      pytz==2019.3
      requests==2.22.0
      scipy==1.4.1
      selenium==3.141.0
      six==1.14.0
      urllib3==1.25.8
      virtualenv==20.0.2
      Werkzeug==1.0.0
      zipp==2.2.0
  * ### Model Execution
    The following dependencies need to be installed for the Model Execution Micro-service
      arm-pyart==1.11.0
      certifi==2019.11.28
      cftime==1.0.4.2
      chardet==3.0.4
      Click==7.0
      confluent-kafka==1.3.0
      cycler==0.10.0
      distlib==0.3.0
      filelock==3.0.12
      Flask==1.1.1
      Flask-Cors==3.0.8
      Flask-Script==2.0.6
      idna==2.8
      imgurpython==1.1.7
      importlib-metadata==1.5.0
      itsdangerous==1.1.0
      Jinja2==2.11.1
      kiwisolver==1.1.0
      MarkupSafe==1.1.1
      matplotlib==3.1.3
      netCDF4==1.5.3
      numpy==1.18.1
      pandas==1.0.1
      pyparsing==2.4.6
      python-dateutil==2.8.1
      pytz==2019.3
      requests==2.22.0
      scipy==1.4.1
      selenium==3.141.0
      six==1.14.0
      urllib3==1.25.8
      virtualenv==20.0.2
      Werkzeug==1.0.0
      zipp==2.2.0
  * ### Post Processing
    The following dependencies need to be installed for the Data Retrieval Micro-service
      appdirs==1.4.3
      arm-pyart==1.11.0
      certifi==2019.11.28
      cftime==1.0.4.2
      chardet==3.0.4
      Click==7.0
      confluent-kafka==1.3.0
      cycler==0.10.0
      distlib==0.3.0
      filelock==3.0.12
      Flask==1.1.1
      Flask-Cors==3.0.8
      Flask-Script==2.0.6
      idna==2.8
      imgurpython==1.1.7
      importlib-metadata==1.5.0
      itsdangerous==1.1.0
      Jinja2==2.11.1
      kiwisolver==1.1.0
      MarkupSafe==1.1.1
      matplotlib==3.1.3
      netCDF4==1.5.3
      numpy==1.18.1
      pandas==1.0.1
      pyparsing==2.4.6
      python-dateutil==2.8.1
      pytz==2019.3
      requests==2.22.0
      scipy==1.4.1
      selenium==3.141.0
      six==1.14.0
      urllib3==1.25.8
      virtualenv==20.0.2
      Werkzeug==1.0.0
      zipp==2.2.0
* ### Ports
  * In order to successfully execute the Project setup the following ports should be idle on the client machine.
    * User Interface
      Port: 3000
    * Data Retrieval
      Port: 7000
    * Model Execution
      Port: 7500
    * Post Processing
      Port: 5500
    * API Gateway
      Port: 4000
    * User Management
      Port: 8085