Skip to content
Open
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
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,12 @@ coverage.xml
.pytest_cache/
.mypy_cache/
.flake8

# Local development and submission-excluded content
/.idea/
/.local/
/Software_testing_images/
/tests/
/docs/
/.test_artifacts/
/.pytest_tmp*/
35 changes: 34 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,16 @@ Or clone & install locally:
```bash
git clone https://github.com/derollins/Python-Nanolocz-Library.git
cd Python-Nanolocz-Library
pip install .
pip install -e .
```

Install optional features only when needed:

```bash
pip install -e ".[notebook]" # Jupyter widgets and plotting
pip install -e ".[io]" # HDF5 readers and writers
pip install -e ".[analysis]" # tables, plots, and advanced segmentation
pip install -e ".[all,dev]" # complete development environment
```

---
Expand All @@ -64,6 +73,30 @@ from the original NanoLocz platform:
These libraries allow the Python implementation to match or exceed MATLAB’s capabilities while remaining open-source and
easily extensible for AFM workflows.

### Stable API

The package root intentionally exposes a small, stable LAFM interface:

```python
from pnanolocz import (
LAFMWorkflow,
detector,
lafm_movie_renderer,
lafm_renderer,
localize,
localize_matlab,
)
```

`LAFMWorkflow.find_all_peaks()` uses OpenCV cubic localization (`cvcubic`) by
default. The previous SciPy `bicubic` method remains available explicitly.
Specialized functionality is imported from its defining submodule, for example
`from pnanolocz.align_trans import align_trans`.

Large validation images in `Software_testing_images` are maintained locally and
are not part of the repository. Tests requiring those files skip clearly when
the directory is unavailable.

---

## 🚀 Quickstart
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added Software_testing_images/LAFM testing/AFM_sim.tiff
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
6,358 changes: 6,358 additions & 0 deletions notebooks/LAFM interactive ROI.ipynb

Large diffs are not rendered by default.

Loading
Loading