How weikangg/bc3412_consulting works
Overall Project Breakdown
• Backend Analysis Engine:
• This includes modules in the “ans_burning_qn1_and_2” and “ans_burning_qn3” directories, which handle different types of analytical algorithms (e.g., duration, scenario, and risk analysis).
• The “groundwork” directory contains essential supporting modules such as data import, cleaning, company processing, ranking, and metrics analysis. These modules form the core engine that orchestrates the data workflow.
• The “consts” and “utils” directories provide constant definitions and utility functions (like saving results) that are shared across the backend processes.
• “main.py” is likely the orchestration entry point that ties together the various analytical components.
• Data Management:
• The “data” directory holds raw input CSV files for different companies (such as “chubu” and “nextera_energy”) across multiple categories (Environment, Financial, Governance, Social, Targets, etc.).
• The output is organized under the “results” directory (and partly mirrored in the “bc3412-dashboard/public/results”), where aggregated scores, detailed analyses, and JSON outputs are stored.
• Frontend Dashboard:
• The “bc3412-dashboard” directory houses the web dashboard. It includes configuration files (like “package.json”, “vite.config.ts”, and ESLint configuration), HTML files, and a “src” directory indicative of a modern TypeScript/React (or similar framework) single-page application.
• This layer is responsible for visual presentation of the analyzed data and results (rendering tables, scores, charts, etc.). It consumes the JSON output files generated by the backend.
Relationships and Data Flow
• Data Initiation:
• Raw CSV datasets (located in “data”) are ingested by the “groundwork” modules (data_import.py and data_cleaning.py).
• Processing and Analysis:
• Processed data is then passed to the “ans_burning_qn*” modules alongside additional processing in “groundwork” for calculating metrics (e.g., duration, scenario rules, risk scores).
• Intermediate data might be transformed or aggregated (e.g., using “ranker.py”, “score_timeseries.py”, and “recommendations_formatter.py”) to compute insights.
• Saving and Storing Results:
• Once processed, the results are saved (using functions in “utils/results_saver.py”) as JSON files in the “results” directory.
• Visualization:
• The “bc3412-dashboard” frontend reads these JSON files (from its “public/results” folder, which seems to mirror or be populated by “results”) to render visualizations and tables, such as the “RiskTable” and “ScoreTable” components.