Metadata-Version: 2.4
Name: marimo_materials
Version: 0.1.0a2
Summary: Collection of Anywidget Widgets
Author: Kane Shenton
License: MIT License
        
        Copyright (c) 2026 John Kane Shenton
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        ---
        
        Portions of this software are based on wigglystuff
        (https://github.com/koaning/wigglystuff)
        Copyright (c) 2022 Vincent D. Warmerdam
        MIT License
License-File: LICENSE
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Requires-Dist: anywidget>=0.9.2
Requires-Dist: drawdata
Requires-Dist: marimo>=0.18.2
Requires-Dist: numpy
Requires-Dist: pillow
Requires-Dist: python-dotenv>=1.2.1
Provides-Extra: crystal
Requires-Dist: ase>=3.27; extra == 'crystal'
Requires-Dist: weas-widget>=0.2.6; extra == 'crystal'
Provides-Extra: docs
Requires-Dist: altair>=6.0.0; extra == 'docs'
Requires-Dist: black>=24.8.0; extra == 'docs'
Requires-Dist: marimo>=0.18.0; extra == 'docs'
Requires-Dist: mike>=2.1.0; extra == 'docs'
Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.2.6; extra == 'docs'
Requires-Dist: mkdocs-include-markdown-plugin>=6.2.1; extra == 'docs'
Requires-Dist: mkdocs-jupyter>=0.25.0; extra == 'docs'
Requires-Dist: mkdocs-material>=9.5.0; extra == 'docs'
Requires-Dist: mkdocs-section-index>=0.3.6; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25.1; extra == 'docs'
Requires-Dist: mohtml>=0.1.11; extra == 'docs'
Requires-Dist: pandas>=2.3.3; extra == 'docs'
Requires-Dist: polars>=1.36.1; extra == 'docs'
Provides-Extra: test
Requires-Dist: matplotlib>=3.0; extra == 'test'
Requires-Dist: pandas>=2.3.3; extra == 'test'
Requires-Dist: polars>=1.36.1; extra == 'test'
Requires-Dist: pytest>=8.3.3; extra == 'test'
Requires-Dist: scikit-learn>=1.0; extra == 'test'
Provides-Extra: test-browser
Requires-Dist: marimo>=0.18.0; extra == 'test-browser'
Requires-Dist: pytest-playwright>=0.6.2; extra == 'test-browser'
Requires-Dist: pytest>=8.3.3; extra == 'test-browser'
Description-Content-Type: text/markdown

# marimo_materials

> Interactive [AnyWidgets](https://anywidget.dev/) for computational materials science notebook environments.

This project is a domain-specific widget library for materials scientists working in notebook environments (Jupyter, Marimo, VSCode, Colab, etc.). It provides interactive UI components tailored to common workflows in computational materials science — visualising crystal structures, monitoring DFT convergence, and more.

## Acknowledgements

This project is based on [wigglystuff](https://github.com/koaning/wigglystuff) by [@koaning](https://github.com/koaning), used and adapted here under the [MIT License](https://github.com/koaning/wigglystuff/blob/main/LICENSE). The scaffold, build system, and anywidget integration patterns are all drawn from that project. Go star it.

## Installation

```bash
uv pip install marimo_materials
# or
pip install marimo_materials
```

## Widgets

> 🚧 This library is in early development. Widgets will be added here as they are built.

## Development

Install all dependencies (Python + JS tooling):

```bash
make install
npm install
```

Run the JS bundler in watch mode while developing:

```bash
npm run dev
```

Run tests:

```bash
make test
```

Preview the docs locally:

```bash
make docs-serve
```

## How It Works

Each widget is a Python class with [traitlets](https://traitlets.readthedocs.io/) that sync bidirectionally with a JavaScript frontend via anywidget. The Python traits are the public API; the JS is purely the renderer. This means widgets work anywhere anywidget is supported — Jupyter, Marimo, Shiny for Python, Solara, VS Code, and Google Colab.

## License

MIT — see [LICENSE](LICENSE).

Original wigglystuff code copyright © [koaning](https://github.com/koaning), MIT License.