Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -194,18 +194,3 @@ ipynb-playground/
CLAUDE.md
AGENTS.md
AGENT.md

# widget (JS build artifacts)
node_modules/
widget/src/quantem/widget/static/

# widget — local-only (per-developer notebooks, docs scratch, build/test scripts).
# Track only src/, js/, tests/test_*.py for now.
widget/.gitignore
widget/docs/
widget/notebooks/
widget/scripts/
!widget/scripts/build.mjs
widget/tests/integration/
widget/tests/snapshots/

7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@ Getting started:
- [install uv](https://docs.astral.sh/uv/getting-started/installation/)
- `git clone` the repo and `cd` into the directory
- run `uv sync` to install all the dependencies in an editable environment
- run `uv sync --all-packages` to also install `quantem.widget` (optional)

For widget developers (requires [Node.js](https://nodejs.org/)):
### Interactive visualization and widget development

- `cd widget && npm install` to install JS dependencies
- `npm run build` to build the widget
- `npm run dev` to watch for changes during development
The interactive visualization package is maintained separately in the [quantem.widget](https://github.com/electronmicroscopy/quantem.widget) repository. To run the widgets, follow its [installation guide](https://electronmicroscopy.github.io/quantem.widget/install.html). To contribute to the Python, TypeScript, or WebGPU widget code, clone that repository and follow its [contributing guide](https://github.com/electronmicroscopy/quantem.widget/blob/main/CONTRIBUTING.md) for the development setup and checks.

The following will set up the pre-commit and [ruff](https://github.com/astral-sh/ruff) for linting and formatting. These commands only need to be run once when first setting up your dev environment:

Expand Down
3 changes: 1 addition & 2 deletions CONTRIBUTORS.md

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will update this later with another PR in the future

Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Contributions are broken down by module:
- [Arthur McCray](https://github.com/arthurmccray)
- [Georgios Varnavides](https://github.com/gvarnavi)
- [Stephanie Ribet](https://github.com/smribet)
- [Sangjoon Bob Lee](https://github.com/bobleesj)

## Imaging
- [Colin Ophus](https://github.com/cophus)
Expand All @@ -44,4 +43,4 @@ see the [GitHub contributors graph](https://github.com/electronmicroscopy/quante
---

This list is maintained by hand and grouped by contribution history. If your name is missing,
listed incorrectly, or you would like it shown differently, please open a pull request or issue.
listed incorrectly, or you would like it shown differently, please open a pull request or issue.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- **Tomography**: fast and accurate HAADF tomography using implicit representations ([Lim et al., 2025](https://arxiv.org/abs/2512.08113)).
- **Imaging**: drift correction and lattice analysis for (S)TEM images.
- **Data structures & I/O**: a unified `Dataset` hierarchy that reads common electron-microscopy formats and serializes to [Zarr](https://zarr.dev/).
- **Visualization**: publication-quality figures with perceptually-uniform colormaps.
- **Visualization**: publication-quality figures with perceptually-uniform colormaps; for interactive, GPU-accelerated visualization, see the companion [quantem.widget](https://github.com/electronmicroscopy/quantem.widget) repository.
- **GPU-accelerated & ML-ready**: a PyTorch backend with neural object representations and multi-GPU / multi-node reconstruction.
- **Spectroscopy**: GPU-accelerated spectra fitting for EDS and EELS, under development.
- **Diffraction**: multi-angle precession electron diffraction (MAPED), under development ([Ribet et al., 2025](https://doi.org/10.1093/mam/ozaf103)).
Expand All @@ -39,6 +39,8 @@ For custom CUDA kernels that accelerate tomography, ptychography, and io behind

The [quantem-tutorials](https://github.com/electronmicroscopy/quantem-tutorials) repository contains Jupyter notebooks that walk through the main workflows for each module.

For interactive visualization in notebooks, command-line workflows, standalone HTML exports, and browser WebGPU, see [quantem.widget](https://github.com/electronmicroscopy/quantem.widget). Its [documentation](https://electronmicroscopy.github.io/quantem.widget/) covers installation, tutorials, supported backends, and complete visualization workflows.

## Citing

If you use quantem in your research, please cite this repository as well as the relevant paper(s) for any module(s) that you used:
Expand All @@ -49,6 +51,7 @@ If you use quantem in your research, please cite this repository as well as the
- **Direct ptychography**: Varnavides, G., Bekkevold, J. M., Ribet, S. M., Scott, M. C., Jones, L., & Ophus, C. (2026). *Relaxing Direct Ptychography Sampling Requirements via Parallax Imaging Insights.* Microscopy and Microanalysis, 32(2), ozaf139. https://doi.org/10.1093/mam/ozaf139
- **Electron tomography (implicit neural representations)**: Lim, C., Casert, C., McCray, A. R. C., Lee, S., Barnum, A., Dionne, J., & Ophus, C. (2025). *Missing Wedge Inpainting and Joint Alignment in Electron Tomography through Implicit Neural Representations.* arXiv:2512.08113. https://arxiv.org/abs/2512.08113
- **Multi-angle precession electron diffraction (MAPED)**: Ribet, S. M., Dhall, R., Ophus, C., & Bustillo, K. C. (2025). *Multi-angle Precession Electron Diffraction (MAPED): A Versatile Approach to 4D-STEM Precession.* Microscopy and Microanalysis, 31(6), ozaf103. https://doi.org/10.1093/mam/ozaf103
- **quantEM interactive visualization framework**: Lee, S., et al. (2026). *Interactive Framework for Real-Time 4DSTEM Analysis and Reconstruction.* Microscopy and Microanalysis, 32(Supplement 1), ozag053.941. https://doi.org/10.1093/mam/ozag053.941


## Contributing
Expand Down
13 changes: 1 addition & 12 deletions pyproject.toml

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revering this PR:

#141

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ build-backend = "hatchling.build"
addopts = [
"--import-mode=importlib",
]
testpaths = ["tests", "widget/tests"]
testpaths = ["tests"]

[tool.ruff.lint]
select = ["E4","E7","E9","F","I"]
Expand All @@ -21,12 +21,6 @@ line-length = 99
[tool.uv]
config-settings = { editable_mode = "compat" }

[tool.uv.workspace]
members = ["widget"]

[tool.uv.sources]
"quantem.widget" = { workspace = true }

[project]
name = "quantem"
version = "0.1.9"
Expand Down Expand Up @@ -56,11 +50,6 @@ dependencies = [
"torchinfo>=1.8.0",
]

[project.optional-dependencies]
widgets = [
"quantem.widget",
]

[tool.hatch.build.targets.sdist]
# hatchling always includes:
# pyproject.toml, .gitignore, any README, any LICENSE, AUTHORS
Expand Down
Loading