Skip to content

Folder Structure

Below is the folder structure of Meerkat:

Folder Descriptions

  • MEERKAT:Contains of folders data, docs, meerkat, mkdocs, settings, simulator, src, test, test_meerkat, toolbox and utils.Also their is meerkat and sat_module_t1 python file. Also contains of requirements.txt file

    • data/web/: Stores input, output, and configuration folders required for testing.Also it contains of csv files and views python script.

      • configuration: Contains of configuration json files.
      • input: Contains of input json files.
      • output: Contains of output images.
    • docs: Document contains meerkat related documents like flowcharts and sample log files.

    • meerkat/: Main Meerkat module containing core scripts:

      • base/: Houses core functions of Meerkat.
      • utils/: Contains essential utility scripts such as:
        • CRUDscript.py: Validates CRUD operations.
        • DBscript.py: Checks database mandatory columns.
        • Regexscript.py: Helps validate code patterns.
      • web/: Contains Python scripts for web-related tests.
    • mkdocs: Contains of markdown files

      • docs: Contains of folder structure, meerkat info, major components markdown document.
      • releases: Contains release notes for meerkat.
    • settings: Configuration files for meerkat.

    • simulator: Contains simulator application and port related files.

      • binaries: Contanins of node.exe file.
      • libs: Contains of nodeSimulator python file.
      • Manet-master: Contains of AdhocSim python file.
      • src: Contains of c language files.
    • src: Contains of flaskapp and meerkat_classes python files.

      • static: Contains of assets, css and js folders
      • templates: Contains of html files.
      • flaskapp.py: Flask application for Meerkat.
      • meerkat_classes.py: Classes for Meerkat.
    • test: This test folder contains of data, library, results and scripts folder.

      • data: Contains of credfile and jsonForm folder, also some other json files.
        • credfile This folder should contain of specific project credentials json files.
        • jsonForm This folder should contain of json files for specific project.
        • logs This folder should contain of logs files for specific project and log_parser python file.
      • libs: Contains of library folders like base, db, hardware, modules and sanity.
        • base: Contains of base library python files.
        • db: Contains of database testing script python files.
        • hardware: Contains of hardware logparser testing script python file.
        • modules: Contains of module web application python file.
        • sanity: Contains of web application sanity testing file.
      • results: Contains of sanity folder.
        • sanity: Contains of csv output files.
      • scripts: Contains of python files for testing applications.
    • test_meerkat: Contains of folders like report_result, settings, static, templates and main and test python files.

      • report_result: Contains of report_result csv files.
      • settings: Contains of configuration json files.
      • static: Contains of assets, css, IMG and js folders
      • templates: Contains of html files.
    • toolbox: Contains of folders like data, files, templates and pthon scripts like djtoolbox, idtoolbox and py_jinja.

      • data: Contains of csv files.
      • files: Files contains of input and output folders.
        • input: Contains of html file.
        • output: Contains of html file.
      • templates: Contains of html file.
    • utils: Contains of python script files for check code indentation and check comments.

    • requirements.txt: Lists required dependencies for the project.