Tungsten Documentation
Tungsten is a Neovim plugin that seamlessly integrates Wolfram functionalities directly into your editor. Designed to eliminate context switching, it brings powerful mathematical capabilities—including equation solving, symbolic calculus, and 3D plotting—right into your buffer using standard LaTeX syntax.
Documentation
-
Introduction New here? Start with installation, configuration, and a quick tour of the plugin's core philosophy.
-
Domains Deep dives into specialized domains including Algebra, Calculus, Differential Equations, Linear Algebra, and Plotting.
-
Reference Detailed API documentation, command lists, syntax grammar specifications, and backend integration specifics.
Key Features
- Seamless Workflow: Evaluate LaTeX-formatted math without leaving Neovim.
- Specialized Domains: specialized handling for Arithmetic, Calculus, Linear Algebra, and more.
- Rich Plotting: Generate 2D curves, 3D surfaces, and scatter plots directly from your code.
- LaTeX Native: Write mathematical expressions using standard LaTeX syntax and shorthand.
Quick Install
For lazy.nvim users:
{
"B1gum/Tungsten",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-telescope/telescope.nvim", -- Optional
"folke/which-key.nvim", -- Optional
},
build = "./scripts/install_python_deps.sh",
opts = {
-- Configuration options
},
}
Need more detail or using a different package manager? See the Installation Guide.
Tungsten relies on the Wolfram Engine and WolframScript. Follow the full walkthrough in the Installation Guide to:
- Download and install the Wolfram Engine.
- Install WolframScript.
- Activate a free Wolfram Engine license.
Getting Started
- Learn the workflow in the Quickstart Guide.
- Customize Tungsten in the Configuration Guide.
- Explore domain-specific syntax in Domains.
Contributing
Contributions are welcome! Please follow the guidelines in the Contributing Guide and open issues or PRs as needed.
Running Tests
Run the test suite with:
make test
The test helper will install Lua dependencies via luarocks and clone plenary.nvim into ~/.local/share/nvim/lazy if it is missing.
License
This project is licensed under the MIT License.
Contact
For any questions or suggestions, feel free to open an issue or contact B1gum.
For an overview of all the documentation pages see the Table of Contents.
