Update README.md

Author: sudipto3331

README.md

@@ -1,4 +1,4 @@
-## Bisection Method Implementation in Python
+# Bisection Method Implementation in Python
 
 This repository contains a Python implementation of the Bisection Method for finding roots of nonlinear equations. The code includes input validation, iteration, and termination based on the desired error or reaching the maximum number of iterations. Results are saved into an Excel file.
 
@@ -7,6 +7,12 @@ This repository contains a Python implementation of the Bisection Method for fin
 - [Dependencies](#dependencies)
 - [Installation](#installation)
 - [Usage](#usage)
+- [Code Explanation](#code-explanation)
+- [Example](#example)
+- [Files in the Repository](#files-in-the-repository)
+- [Input Parameters](#input-parameters)
+- [Troubleshooting](#troubleshooting)
+- [Author](#author)
 
 ### Bisection Method Theory
 The Bisection Method is a numerical technique to find roots of a continuous function where the function changes signs over an interval. The main idea leverages the Intermediate Value Theorem, which states that if a function changes sign over an interval, it must cross zero within that interval.
@@ -31,19 +37,18 @@ pip install numpy xlwt
 
 ### Usage
 1. Clone the repository.
-2. Run the script using Python:
-
-```sh
-python bisection_method.py
-```
-
-3. Provide the required inputs when prompted:
-   - Enter the first initial value (\( x_l \)).
-   - Enter the second initial value (\( x_u \)).
-   - Enter the desired percentage relative error.
-   - Enter the number of iterations.
-
-4. The script will compute the bisection method iterations and save the results in an Excel file named `LAB1.xls`.
+2. Ensure the script and the Excel file (`LAB1.xls`) are in the same directory.
+3. Run the script using Python:
+    ```sh
+    python bisection_method.py
+    ```
+4. Provide the required inputs when prompted:
+    - Enter the first initial value (\( x_l \)).
+    - Enter the second initial value (\( x_u \)).
+    - Enter the desired percentage relative error.
+    - Enter the number of iterations.
+
+5. The script will compute the bisection method iterations and save the results in an Excel file named `LAB1.xls`.
 
 ### Code Explanation
 The code starts by importing the necessary libraries and taking user input for the initial values, desired relative error, and number of iterations. Then, it initializes arrays to store intermediate results. The main iteration loop of the Bisection Method computes the midpoints and function values, updating the intervals as necessary, until the termination criteria are met. Finally, the results are written into an Excel sheet.
@@ -80,8 +85,46 @@ for i in range(ite):
 
 The code completes by saving the final results into the Excel file `LAB1.xls`.
 
+### Example
+Below is an example of how to use the script:
+
+1. **Run the script**:
+    ```sh
+    python bisection_method.py
+    ```
+
+2. **Enter the input values**:
+    ```
+    Enter 1st initial value: 20
+    Enter 2nd initial value: 30
+    Enter desired percentage relative error: 0.001
+    Enter number of iterations: 50
+    ```
+
+3. **Output**:
+    - The script will compute the Bisection Method iterations and print intermediate results on the console.
+    - The final results will be saved in an Excel file named `LAB1.xls`.
+
 ### Files in the Repository
 - `bisection_method.py`: The main script for performing the Bisection Method
 - `LAB1.xls`: Excel file generated by running the script
 
-Feel free to contribute by creating issues and submitting pull requests. Happy coding!
+### Input Parameters
+The script prompts for the following input values:
+- Initial guess for the lower bound (`xl`).
+- Initial guess for the upper bound (`xu`).
+- Desired percentage relative error (`err`).
+- Number of iterations (`ite`).
+
+### Troubleshooting
+1. **Initial Input Values**: Ensure that the initial guesses bracket the root (`f(xl) * f(xu) < 0`). If they do not, the script will print "Wrong initial input".
+2. **Function Evaluation**: The function `(667.38/x)*(1-math.exp(-0.146843*x))-40` is hardcoded. Modify it as needed for different functions.
+3. **Excel File Creation**: Ensure you have write permissions in the directory where the script is run to save the Excel file.
+4. **Python Version**: This script is compatible with Python 3. Ensure you have Python 3 installed.
+
+## Author
+Script created by sudipto3331.
+
+---
+
+This documentation should guide you through understanding, installing, and using the Bisection Method script. For further issues or feature requests, please open an issue in the repository on GitHub. Feel free to contribute by creating issues and submitting pull requests. Happy coding!