Skip to content

Commit fe28e53

Browse files
committed
Update README.md
1 parent 48d0f14 commit fe28e53

File tree

2 files changed

+36
-16
lines changed

2 files changed

+36
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33

44
FunKit bridges the gap between symbolic mathematics (SymPy) and numerical computations (NumPy/SciPy), offering a unified interface that maintains mathematical rigor while providing practical tools for real-world problems.
55

6-
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
6+
![Static Badge](https://img.shields.io/badge/Python-3.11%2B-blue?logo=python)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88

9-
**Ready to revolutionize your mathematical computing workflow?**
10-
```bash
9+
**Ready to revolutionize your mathematical computing workflow?**
10+
```bash
1111
pip install funkit
12-
```
12+
```
1313

14-
**Have Questions? Take a look at the Q&A:**
14+
**Have Questions? Take a look at the Q&A:**
1515
[Questions & Answers: Addressing Potential Concerns](docs/QA.md)
1616

1717
## ✨ Key Features
@@ -45,24 +45,24 @@ result = f(2.5) # Numerically evaluate at x = 2.5
4545

4646
# Use the .n attribute to access fast numerical methods
4747
numerical_roots = f.n.all_roots()
48-
# or call f's n-prefixed methods directly to use variable precision numerical methods
49-
roots = f.nsolve_all()
48+
# Call f's n-prefixed methods to use variable precision numerical methods
49+
precise_roots = f.nsolve_all(prec=50) # 50 digits of accuracy
5050

51-
# Beautiful printing options
52-
f.print() # quick and easy printing
51+
# quick and easy printing
52+
f.print()
5353
f.print('latex')
5454
f.print('mathematica_code')
5555
# or
5656
print(f.print.latex()) # LaTeX output
57-
print(f.print.ccode()) # Pretty ASCII art
57+
print(f.print.ccode()) # c code output
5858
```
5959

6060

61-
## 🎯 Numerical Computing
61+
## 🎯 Numerical Computing
6262

6363
FunKit excels at bridging symbolic and numerical mathematics:
6464
```python
65-
f = Expression("x^3 - 2*x^2 + x - 1")
65+
f = Expression("x^3 - 2x^2 + x - 1")
6666

6767
# Root finding
6868
all_roots = f.n.all_roots(bounds=(-5, 5))
@@ -105,13 +105,13 @@ expr = Expression("2x^2 + ln(|x-1|)")
105105
from sympy import sin, cos
106106
expr = Expression(sin(x) + cos(x))
107107

108-
# Numerical methods via .n attribute
109-
roots = expr.n.all_roots(bounds=(-10, 10))
110-
integral = expr.n.quad(0, 1) # Numerical integration
111-
112108
# Symbolic operations
113109
derivative = expr.diff(x)
114110
expanded = expr.expand()
111+
112+
# Numerical methods via .n attribute
113+
roots = expr.n.all_roots(bounds=(-10, 10))
114+
integral = expr.n.quad(0, 1) # Numerical integration
115115
```
116116

117117

pyproject.toml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[build-system]
2+
requires = ["setuptools"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "funkit"
7+
version = "0.1.0"
8+
description = "A Pythonic Interface for Symbolic and Numerical Mathematics"
9+
license = {text = "MIT"}
10+
authors = [{name = "Isaac Wolford", email = "[email protected]"}]
11+
requires-python = ">=3.11"
12+
dependencies = [
13+
"sympy",
14+
"scipy",
15+
"tabulate",
16+
]
17+
18+
[project.urls]
19+
Homepage = "https://github.com/cybergeek1943/funkit/"
20+
Repository = "https://github.com/cybergeek1943/funkit/"

0 commit comments

Comments
 (0)