Skip to content

Release v1.0.1: Testing Infrastructure & Documentation Polish

Choose a tag to compare

View all tags
@Routhleck Routhleck released this 06 Feb 04:46
· 12 commits to master since this release
v1.0.1
d16b325

What's New

🔧 Testing Infrastructure Overhaul

  • Restructured test suite with unit/integration separation for better organization
  • Optimized CI pipeline for faster test execution
  • Expanded test coverage across core APIs and modules

📖 Documentation Enhancements

  • Reorganized documentation assets to docs/_static/ for better structure
  • Enhanced installation instructions with accelerator options (CUDA 12/13, TPU)
  • Updated badges and citation information with Zenodo DOI
  • Added comprehensive 1D CANN tracking example

Major Features / Key Changes

🔧 Testing & CI Improvements (PR #96)

  • Test suite restructure: Reorganized tests into unit/ and integration/ directories for clearer separation of concerns
  • CI optimization: Streamlined pytest configuration and environment setup for faster CI runs
  • Coverage expansion: Added comprehensive tests for:
    • CLI functionality (test_cli.py)
    • Lazy import system (test_lazy_imports.py)
    • Data loaders (test_loaders.py)
    • Task base classes (test_task_base.py)
    • Utility benchmarking (test_benchmark.py)
    • Pipeline launcher (test_launcher.py)
  • Test improvements: Enhanced existing tests with better fixtures and organization

📖 Documentation Organization

  • Asset relocation: Moved documentation images from images/ to docs/_static/ for better structure
  • Updated references: Fixed all image paths in README (EN/ZH), paper.md, and documentation files
  • Enhanced architecture: Expanded architecture diagram caption with detailed five-layer hierarchy (Application → Functional → Core Models → Foundation → Hardware)

📖 Documentation Content Updates

  • Status badges: Updated to "stable" status and 2026 maintenance year
  • Zenodo DOI: Added DOI badge linking to v1.0.0 Zenodo record
  • Installation guide: Enhanced with CPU install, optional accelerators (canns[cuda12], canns[cuda13], canns[tpu]), GUI extras, and uv installation path
  • Quick Start example: Added 1D CANN smooth-tracking demonstration with imports, model/task setup, simulation loop, and energy-landscape animation
  • Citation updates: Replaced citation with 2026 v1.0.0 Zenodo record and expanded author list

🎯 User Experience Improvements

  • CLI module: Added src/canns/__main__.py for better command-line interface support
  • Pip examples: Normalized pip install commands by removing unnecessary quotes for consistency
  • Documentation URL: Updated to https://routhleck.com/canns

Technical Improvements

  • Test organization: Clear separation between unit tests (isolated component testing) and integration tests (multi-component workflows)
  • CI performance: Optimized pytest configuration and environment setup
  • Documentation structure: Centralized static assets in docs/_static/ directory
  • Git tracking: Updated .gitignore to allow GIFs under docs/_static/

Files Modified

Key changes:

  • Test suite reorganization: tests/ → tests/unit/ and tests/integration/
  • Documentation assets: images/ → docs/_static/
  • New CLI entry point: src/canns/__main__.py
  • Updated documentation: README.md, README_zh.md, CITATION.cff, paper.md
  • CI configuration: .github/workflows/ci.yml, pyproject.toml

Breaking Changes

None - all changes are backward compatible.

Full Changelog: v1.0.0...v1.0.1

Assets 2
Loading