Spaces:
Runtime error
Runtime error
feat: update README.md for improved clarity and installation instructions
Browse files
README.md
CHANGED
@@ -9,11 +9,13 @@ app_file: app.py
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
-
|
13 |
|
14 |
## Overview
|
15 |
|
16 |
-
|
|
|
|
|
17 |
|
18 |
## Features
|
19 |
|
@@ -28,6 +30,38 @@ This application provides a suite of mathematical tools organized by topic (e.g.
|
|
28 |
- **Vectors**: Addition, Subtraction, Dot Product, Cross Product
|
29 |
- **Operations Research**: Branch & Bound, Dual Simplex, Simplex Solver Steps
|
30 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
31 |
## Project Structure
|
32 |
|
33 |
```text
|
@@ -37,35 +71,36 @@ counting/
|
|
37 |
โโโ README.md # Project documentation (this file)
|
38 |
โโโ maths/ # Mathematical modules organized by topic
|
39 |
โโโ arithmetic/ # Arithmetic logic & interfaces
|
40 |
-
โ โโโ arithmetic.py
|
41 |
-
โ โโโ arithmetic_interface.py
|
42 |
โโโ number_theory/ # Number theory logic & interfaces
|
43 |
-
โ โโโ number_theory.py
|
44 |
-
โ โโโ number_theory_interface.py
|
45 |
โโโ algebra/ # Algebra logic & interfaces
|
46 |
-
โ โโโ algebra.py
|
47 |
-
โ โโโ algebra_interface.py
|
48 |
โโโ equations/ # Equation solvers & interfaces
|
49 |
-
โ โโโ equations.py
|
50 |
-
โ โโโ equations_interface.py
|
51 |
โโโ geometry/ # Trigonometry & geometry logic & interfaces
|
52 |
-
โ โโโ geometry.py
|
53 |
-
โ โโโ geometry_interface.py
|
54 |
โโโ calculus/ # Calculus logic & interfaces
|
55 |
-
โ โโโ calculus.py
|
56 |
-
โ โโโ calculus_interface.py
|
57 |
โโโ differential_equations/ # ODE solvers & interfaces
|
58 |
-
โ โโโ differential_equations.py
|
59 |
-
โ โโโ differential_equations_interface.py
|
60 |
โโโ matrices/ # Matrix operations logic & interfaces
|
61 |
-
โ โโโ matrices.py
|
62 |
-
โ โโโ matrices_interface.py
|
63 |
โโโ vectors/ # Vector operations logic & interfaces
|
64 |
-
โ โโโ vectors.py
|
65 |
-
โ โโโ vectors_interface.py
|
66 |
โโโ operations_research/ # Operations research solvers & interfaces
|
67 |
-
โโโ operations_research_interface.py
|
68 |
-
โโโ BranchAndBoundSolver.py
|
69 |
-
โโโ DualSimplexSolver.py
|
70 |
-
โโโ simplex_solver_with_steps.py
|
71 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
9 |
pinned: false
|
10 |
---
|
11 |
|
12 |
+
[](https://www.python.org/downloads/) [](LICENSE)
|
13 |
|
14 |
## Overview
|
15 |
|
16 |
+
Math Tools is a suite of interactive mathematical calculators and solvers, organized by topic (Algebra, Calculus, Differential Equations, etc.) and built with Python and Gradio. It is designed for students, educators, and anyone needing quick, visual math solutions.
|
17 |
+
|
18 |
+
---
|
19 |
|
20 |
## Features
|
21 |
|
|
|
30 |
- **Vectors**: Addition, Subtraction, Dot Product, Cross Product
|
31 |
- **Operations Research**: Branch & Bound, Dual Simplex, Simplex Solver Steps
|
32 |
|
33 |
+
---
|
34 |
+
|
35 |
+
## Getting Started
|
36 |
+
|
37 |
+
### Installation
|
38 |
+
|
39 |
+
1. **Clone the repository:**
|
40 |
+
|
41 |
+
```bash
|
42 |
+
git clone https://github.com/yourusername/math-tools.git
|
43 |
+
cd math-tools
|
44 |
+
```
|
45 |
+
|
46 |
+
2. **Install dependencies:**
|
47 |
+
|
48 |
+
```bash
|
49 |
+
pip install -r requirements.txt
|
50 |
+
```
|
51 |
+
|
52 |
+
3. **Run the app:**
|
53 |
+
|
54 |
+
```bash
|
55 |
+
python app.py
|
56 |
+
```
|
57 |
+
|
58 |
+
### Usage
|
59 |
+
|
60 |
+
- Open the app in your browser (Gradio will provide a local URL).
|
61 |
+
- Select a topic tab and use the calculators or solvers interactively.
|
62 |
+
|
63 |
+
---
|
64 |
+
|
65 |
## Project Structure
|
66 |
|
67 |
```text
|
|
|
71 |
โโโ README.md # Project documentation (this file)
|
72 |
โโโ maths/ # Mathematical modules organized by topic
|
73 |
โโโ arithmetic/ # Arithmetic logic & interfaces
|
|
|
|
|
74 |
โโโ number_theory/ # Number theory logic & interfaces
|
|
|
|
|
75 |
โโโ algebra/ # Algebra logic & interfaces
|
|
|
|
|
76 |
โโโ equations/ # Equation solvers & interfaces
|
|
|
|
|
77 |
โโโ geometry/ # Trigonometry & geometry logic & interfaces
|
|
|
|
|
78 |
โโโ calculus/ # Calculus logic & interfaces
|
|
|
|
|
79 |
โโโ differential_equations/ # ODE solvers & interfaces
|
|
|
|
|
80 |
โโโ matrices/ # Matrix operations logic & interfaces
|
|
|
|
|
81 |
โโโ vectors/ # Vector operations logic & interfaces
|
|
|
|
|
82 |
โโโ operations_research/ # Operations research solvers & interfaces
|
|
|
|
|
|
|
|
|
83 |
```
|
84 |
+
|
85 |
+
---
|
86 |
+
|
87 |
+
## Example
|
88 |
+
|
89 |
+

|
90 |
+
|
91 |
+
---
|
92 |
+
|
93 |
+
## Contributing
|
94 |
+
|
95 |
+
Contributions are welcome! To contribute:
|
96 |
+
|
97 |
+
1. Fork this repository
|
98 |
+
2. Create a new branch (`git checkout -b feature/your-feature`)
|
99 |
+
3. Commit your changes
|
100 |
+
4. Open a pull request
|
101 |
+
|
102 |
+
---
|
103 |
+
|
104 |
+
## License
|
105 |
+
|
106 |
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|