update docs

docs/changelog.rst

@@ -3,6 +3,17 @@ Release Notes
 ===============
 
 
+Version 0.1.5
+---------------
+
+* **Release date:** 13-Oct-2024
+
+* **Feature Additions:**
+
+    * Introduced the :class:`BharatFinTrack.Visual` class for data visualization.
+    * Added the :meth:`BharatFinTrack.Visual.plot_category_sort_index_cagr_from_launch` method for plotting the descending sort of CAGR (%) by index category since inception.
+
+
 Version 0.1.4
 ---------------
 

docs/functionality.rst

@@ -6,6 +6,8 @@ Functionality
 A brief overview of several features related to making investment decisions.
 
 
+
+
 Class Instance
 ----------------
 Let's start by instantiating the classes.
@@ -17,6 +19,9 @@ Let's start by instantiating the classes.
     nse_tri = BharatFinTrack.NSETRI()
 
 
+
+.. _fucn_equity_index_price_cagr:
+
 Equity Index Price CAGR
 --------------------------
 
@@ -26,7 +31,7 @@ It helps users make informed decisions about investments in passive funds that t
 .. code-block:: python
 
     nse_index.sort_equity_cagr_from_launch(
-        excel_file=r"C:\Users\Username\Folder\sort_cagr.xlsx"
+        excel_file=r"C:\Users\Username\Folder\sort_price_cagr.xlsx"
     )
     
     
@@ -37,10 +42,12 @@ better understand the difference in index returns across various categories
 .. code-block:: python
 
     nse_index.category_sort_equity_cagr_from_launch(
-        excel_file=r"C:\Users\Username\Folder\category_sort_cagr.xlsx"
+        excel_file=r"C:\Users\Username\Folder\sort_price_cagr_by_category.xlsx"
     )
     
-    
+
+.. _fucn_equity_tri_cagr:
+
 Equity TRI CAGR
 ------------------
 Download the closing Total Return Index (TRI) values for all NSE indices. These values are not updated on the website on a daily basis. 
@@ -64,13 +71,13 @@ The above Excel file will be used to sort the equity indices based on the CAGR (
     # sort equity indices by CAGR (%) since launch
     nse_tri.sort_equity_cagr_from_launch(
         input_excel=excel_file,
-        output_excel=r"C:\Users\Username\Folder\sorted_tri_cagr.xlsx"
+        output_excel=r"C:\Users\Username\Folder\sort_tri_cagr.xlsx"
     )
     
     # sort equity indices by CAGR (%) since launch within each category 
     nse_tri.category_sort_equity_cagr_from_launch(
         input_excel=excel_file,
-        output_excel=r"C:\Users\Username\Folder\category_sort_tri_cagr.xlsx"
+        output_excel=r"C:\Users\Username\Folder\sort_tri_cagr_by_category.xlsx"
     )
 
 

docs/index.rst

@@ -11,6 +11,7 @@ Welcome to BharatFinTrack's documentation!
    quickstart
    download
    functionality
+   visualization
    modules
    changelog
 

docs/introduction.rst

@@ -16,4 +16,5 @@ BharatFinTrack is a Python package designed to simplify the process of downloadi
 
     - Calculates the updated CAGR (%) of all NSE equity index prices and TRI since their inception.
     - Sorts equity indices by CAGR (%) values since inception.
+    - Plots the descending sort of CAGR (%) by index category since inception.
 

docs/visualization.rst

@@ -0,0 +1,60 @@
+===============
+Visualization
+===============
+
+A brief overview of several features related to data visualization.
+
+Class Instance
+----------------
+Let's start by instantiating the class.
+
+.. code-block:: python
+
+    import BharatFinTrack
+    visual = BharatFinTrack.Visual()
+
+
+Equity Index Closing Values
+-----------------------------
+
+In this section, we plot a bar graph of equity index closing values, sorted in descending order of CAGR (%) by category. 
+To obtain the required data, use the Excel files generated from the :ref:`Equity Index Price CAGR <fucn_equity_index_price_cagr>` 
+and :ref:`Equity TRI CAGR <fucn_equity_tri_cagr>` sections. The following code produces a plot of the closing TRI values. 
+You can also experiment with index prices to observe differences in the results.
+
+
+.. code-block:: python
+    
+    excel_file = r"C:\Users\Username\Folder\tri_closing_value.xlsx"
+    
+    # plot descending sort of TRI CAGR by category since launch
+    visual.plot_category_sort_index_cagr_from_launch(
+        excel_file=r"C:\Users\Username\Folder\sort_tri_cagr_by_category.xlsx"
+        figure_file=r"C:\Users\Username\Folder\plot_tri.png"
+    )
+    
+    
+The output plot looks similar to the following figure subject to the change of closing values which chanage in each trading day.
+
+
+.. image:: _static/tri_category_sort_cagr_from_launch.png
+   :align: left
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+