Merge branch 'main' of https://github.com/mgao6767/brms

src/brms/__init__.py

@@ -1,4 +1,11 @@
-"""BRMS - Bank Risk Management Simulation."""
+"""BRMS - Bank Risk Management Simulation.
+
+BRMS is an educational tool designed to provide users with an in-depth understanding of bank risk management practices.
+It allows users to simulate and respond to various risk scenarios, and analyze the impact on a bank's financial health.
+
+BRMS generally follows the Model-View-Controller (MVC) design pattern for maintainability.
+Additional modules are to implement core functionalities that are independent of the GUI.
+"""
 
 import importlib.metadata
 import os

src/brms/accounting/__init__.py

@@ -1 +1 @@
-"""Module providing basic double-entry accounting system for a bank."""
+"""Module for bank accounting."""

src/brms/accounting/account.py

@@ -1,3 +1,5 @@
+"""Module for various types of accounts used in a bank's chart of accounts."""
+
 from collections import UserDict
 from collections.abc import Generator
 from dataclasses import dataclass, field

src/brms/accounting/journal.py

@@ -1,4 +1,4 @@
-"""Module for handling journal entries in accounting."""
+"""Module for accounting journal and entries."""
 
 import datetime
 from abc import ABC, abstractmethod

src/brms/accounting/ledger.py

@@ -1,4 +1,4 @@
-"""Defines the Ledger class, which represents a ledger in an accounting system."""
+"""Module for accounting ledger."""
 
 import copy
 import datetime

src/brms/accounting/report.py

@@ -1,4 +1,4 @@
-"""Provides classes for generating financial statements and reports."""
+"""Module for financial statements and reports."""
 
 import datetime
 from abc import ABC, abstractmethod

src/brms/controllers/__init__.py

@@ -0,0 +1 @@
+"""Module for MVC controllers in the GUI application."""

src/brms/data/__init__.py

@@ -1,3 +1,5 @@
+"""Module for simulation data loading."""
+
 import os
 
 DEFAULT_DATA_FOLDER = os.path.join(os.path.dirname(__file__), "default")

src/brms/data/data_loader.py

@@ -1,3 +1,5 @@
+"""Module for data loader."""
+
 import os
 from abc import ABC, abstractmethod
 

src/brms/data/default/__init__.py

@@ -1,3 +1,5 @@
+"""Module for default simulation."""
+
 import datetime
 import random
 from collections.abc import Generator

src/brms/data/schema.py

@@ -1,3 +1,5 @@
+"""Module for schemas in the BRMS."""
+
 from brms.models.base import ScenarioData
 
 SCHEMA = {

src/brms/instruments/__init__.py

@@ -0,0 +1 @@
+"""Module for various financial instruments."""

src/brms/metrics/__init__.py

@@ -0,0 +1 @@
+"""Module for computing Basel III metrics."""

src/brms/models/__init__.py

@@ -0,0 +1 @@
+"""Module for MVC models in the GUI application."""

src/brms/services/__init__.py

@@ -0,0 +1,5 @@
+"""Module for various computing services.
+
+The services module contains various service classes and functions that
+provide core functionalities and business logic for the BRMS application.
+"""

src/brms/utils/__init__.py

@@ -1,3 +1,5 @@
+"""Module for utility functions and classes."""
+
 import datetime
 import time
 from abc import ABC, abstractmethod

src/brms/views/__init__.py

@@ -0,0 +1 @@
+"""Module for MVC views in the GUI application."""