Skip to content

v0.1.0

Latest
Latest

Choose a tag to compare

View all tags
@derollins derollins released this 02 Mar 15:47
· 10 commits to main since this release
Immutable release. Only release title and notes can be modified.
v0.1.0
d022e0d
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

pnanolocz v0.1.0 — Initial Public PyPi Release

This release marks the first public version of pnanolocz, the Python implementation of the NanoLocz AFM/HS‑AFM levelling and analysis library, to be released on PyPi.
It includes a full package rename, modernised source layout, updated documentation, refreshed metadata, and new GitHub issue templates.

What's changed?

Package Rename & Restructure

  • Renamed the project from pnanolocz_lib → pnanolocz.
  • Moved all source code to a src/pnanolocz/ layout.
  • Updated all imports, module paths, entry points, and tests.
  • Updated coverage, mypy, Ruff, and isort configs to match the new structure.
  • Updated version file target for setuptools_scm.

Packaging & Metadata Improvements

  • Updated pyproject.toml:
    • renamed the distribution to pnanolocz
    • added Issues and Changelog URLs
    • updated playnano filter entry points
    • corrected author information
  • Updated CITATION.cff (fixed email + metadata cleanup).
  • Added full CHANGELOG.md following Keep a Changelog conventions.

Documentation Overhaul

  • Rewrote the README:
    • updated install instructions (pip install pnanolocz)
    • updated import paths
    • updated module documentation
    • refreshed examples and code blocks
    • added CI / coverage / license badges
  • Updated module references in docstrings (pnanolocz.level, pnanolocz.level_auto, etc.).

Repository Improvements

GitHub Issue Templates

Added modern GitHub issue forms:

  • Bug Report
  • Feature Request

CI & Tests

  • Updated coverage configuration to --cov=pnanolocz.
  • Updated all test imports to use the new package name.
  • Ensured all core modules import correctly after the rename.

Housekeeping

  • Updated .gitignore.
  • Corrected duplicate dist/ entries.
  • Cleaned up outdated references to pnanolocz_lib.

No Algorithm Changes in v0.1.0

This release contains no functional or numerical changes to levelling, thresholding, automated routines, or region‑weighted methods.
All algorithmic updates remain in previous versions (0.0.3, 0.0.4).

v0.1.0 is a structural and packaging milestone to prepare the project for PyPI publication.

Summary

This release:

  • finalises the rename to pnanolocz,
  • modernises the project layout,
  • updates all imports, metadata, and documentation,
  • adds issue templates and citation metadata,
  • and prepares the library for PyPI distribution.

This is the foundation for all future development and public releases.

Links

Assets 3
Loading