numbl 0.0.12 → 0.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # Numbl
2
2
 
3
- Numbl is an open-source numerical computing environment that aims to be compatible with Matlab. It works by compiling `.m` source code to JavaScript and executing it directly. It can work in the browser or on the command line.
3
+ Numbl is an open-source numerical computing environment that aims to be compatible with Matlab.
4
4
 
5
5
  **Early stage project.** Numbl is under active development and new functionality is being added regularly.
6
6
 
7
7
  ## Try it in the browser
8
8
 
9
- You can try numbl directly in the browser at <https://magland.github.io/numbl> — no installation required. All execution happens locally in your browser. Note that the browser version has limited functionality and is slower than the CLI.
9
+ You can try numbl directly in the browser at <https://numbl.org> — no installation required. All execution happens locally in your browser. Note that the browser version has limited functionality and is slower than the desktop/command-line version.
10
10
 
11
11
  ## Installation
12
12
 
@@ -14,7 +14,7 @@ You can try numbl directly in the browser at <https://magland.github.io/numbl>
14
14
  npm install -g numbl
15
15
  ```
16
16
 
17
- To enable fast linear algebra (matrix inverse, SVD, eigenvalues, etc.), build the native LAPACK addon:
17
+ To enable fast linear algebra, build the native LAPACK addon:
18
18
 
19
19
  ```bash
20
20
  # Prerequisites: C++ compiler, libopenblas-dev, libfftw3-dev (or equivalents for your OS)
@@ -26,38 +26,12 @@ numbl build-addon
26
26
  ```bash
27
27
  numbl # interactive REPL
28
28
  numbl run script.m # run a .m file
29
- numbl eval "disp(eye(3))" # evaluate inline code
29
+ numbl eval "disp(eye(3))" # evaluate inline code
30
30
  numbl info # print info (JSON), including native addon status
31
31
  numbl list-builtins # list available built-in functions
32
32
  numbl --help # show all commands and options
33
33
  ```
34
34
 
35
- ## Try it with Docker
36
-
37
- Run the REPL instantly — no installation required:
38
-
39
- ```bash
40
- docker run -it node:22 npx numbl
41
- ```
42
-
43
- With plotting support (open http://localhost:8234 in your browser):
44
-
45
- ```bash
46
- docker run -it -p 8234:8234 node:22 npx numbl --plot-port 8234
47
- ```
48
-
49
- With native LAPACK support for fast linear algebra:
50
-
51
- ```bash
52
- docker run -it node:22 bash -c "apt-get update && apt-get install -y libopenblas-dev libfftw3-dev && npx numbl build-addon && npx numbl"
53
- ```
54
-
55
- With both LAPACK and plotting:
56
-
57
- ```bash
58
- docker run -it -p 8234:8234 node:22 bash -c "apt-get update && apt-get install -y libopenblas-dev libfftw3-dev && npx numbl build-addon && npx numbl --plot-port 8234"
59
- ```
60
-
61
35
  ## Upgrading
62
36
 
63
37
  ```bash
@@ -66,16 +40,6 @@ npm install -g numbl@latest
66
40
 
67
41
  Note: if you previously built the native addon, you'll need to run `numbl build-addon` again after upgrading.
68
42
 
69
- ## Documentation
70
-
71
- - [Overview](docs/overview.md) — What numbl is and how to use it
72
- - [Architecture](docs/architecture.md) — How the compiler pipeline works
73
- - [Adding built-in functions](docs/adding-builtins.md) — How to contribute new built-ins
74
- - [Test scripts](docs/test-scripts.md) — Writing and running `.m` integration tests
75
- - [Development](docs/development.md) — Setting up local development
76
- - [Performance](docs/performance.md) — How numbl achieves computational efficiency
77
- - [Documentation guidelines](docs/documentation-guidelines.md) — Conventions for writing docs
78
-
79
43
  ## Authors
80
44
 
81
45
  Jeremy Magland and Dan Fortunato, Center for Computational Mathematics, Flatiron Institute.