Skip to content

Commit 7a574f9

Browse files
Updates to docs
1 parent e8b6da7 commit 7a574f9

File tree

4 files changed

+54
-21
lines changed

4 files changed

+54
-21
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ These algorithms are designed to solve both **constrained** and **unconstrained*
1515

1616
**Ravipudi Venkata Rao and Ravikumar Shah (2024)**, "BMR and BWR: Two simple metaphor-free optimization algorithms for solving real-life non-convex constrained and unconstrained problems." [arXiv:2407.11149v2](https://arxiv.org/abs/2407.11149).
1717

18+
## Interactive Visualization
19+
20+
Explore these algorithms through our interactive web application:
21+
**[Rao Optimization Algorithms Visualizer](https://vaidhyamegha.github.io/optimization_algorithms/)**
22+
1823
## Features
1924

2025
- **Metaphor-Free**: No reliance on nature-inspired metaphors.

docs/algorithms/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This section provides detailed documentation for all the optimization algorithms implemented in this package.
44

5+
## Interactive Visualization
6+
7+
Explore and compare these algorithms through our interactive web application:
8+
**[Rao Optimization Algorithms Visualizer](https://vaidhyamegha.github.io/optimization_algorithms/)**
9+
510
## Available Algorithms
611

712
- [BMR (Best-Mean-Random) Algorithm](bmr.md): A simple yet effective algorithm that uses the best solution, mean solution, and a random solution to guide the search process.

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
Welcome to the comprehensive documentation for the BMR and BWR optimization algorithms package.
44

5+
## Interactive Visualization
6+
7+
Explore these algorithms through our interactive web application:
8+
**[Rao Optimization Algorithms Visualizer](https://vaidhyamegha.github.io/optimization_algorithms/)**
9+
510
## Contents
611

712
1. [Introduction](introduction.md)

frontend/README.md

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
An interactive web application for visualizing and exploring optimization algorithms developed by Prof. R.V. Rao.
44

5+
## Live Demo
6+
7+
**[Visit the live application](https://vaidhyamegha.github.io/optimization_algorithms/)**
8+
59
## Overview
610

711
This frontend application provides a comprehensive visualization platform for understanding and comparing various optimization algorithms:
@@ -49,27 +53,41 @@ frontend/
4953

5054
### Installation
5155

52-
1. Clone the repository:
53-
```bash
54-
git clone https://github.com/VaidhyaMegha/optimization_algorithms.git
55-
cd optimization_algorithms/frontend
56-
```
57-
58-
2. Install dependencies:
59-
```bash
60-
npm install
61-
# or
62-
yarn install
63-
```
64-
65-
3. Start the development server:
66-
```bash
67-
npm start
68-
# or
69-
yarn start
70-
```
71-
72-
4. Open [http://localhost:3000](http://localhost:3000) to view the application in your browser.
56+
```bash
57+
# Clone the repository
58+
git clone https://github.com/VaidhyaMegha/optimization_algorithms.git
59+
60+
# Navigate to the frontend directory
61+
cd optimization_algorithms/frontend
62+
63+
# Install dependencies
64+
npm install
65+
66+
# Start the development server
67+
npm start
68+
```
69+
70+
The application will be available at `http://localhost:3000`.
71+
72+
## Deployment
73+
74+
The application is deployed on GitHub Pages. To update the deployment:
75+
76+
```bash
77+
# Build and deploy the application
78+
npm run deploy
79+
```
80+
81+
This will:
82+
1. Build an optimized production version of the app
83+
2. Deploy it to the `gh-pages` branch of the repository
84+
3. Make it available at https://vaidhyamegha.github.io/optimization_algorithms/
85+
86+
### Notes on Deployment
87+
88+
- The application uses HashRouter for proper routing on GitHub Pages
89+
- All routes are accessible via hash-based URLs (e.g., `/#/algorithm/bmr`)
90+
- Any changes pushed to the main branch will not automatically update the live site; you must run `npm run deploy`
7391

7492
## Usage
7593

0 commit comments

Comments
 (0)