Skip to content

Releases: ContextLab/clustrix

v0.1.1 (July, 2021)

26 Jun 21:14
@jeremymanning jeremymanning
v0.1.1
34039bc
Compare
Choose a tag to compare
v0.1.1 (July, 2021) Latest
Latest

Clustrix v0.1.1

🔧 Bug Fixes

  • Windows Compatibility: Fixed critical path handling issues that prevented Clustrix from working on Windows systems
  • Documentation Navigation: Resolved 404 errors in Sphinx documentation navigation links

📚 Documentation Improvements

  • New Theme: Switched from groundwork-sphinx-theme to sphinx-wagtail-theme for significantly improved code block readability
  • Custom Logo: Added and properly configured custom logo for ReadTheDocs documentation
  • Interactive Notebooks: Added comprehensive tutorial notebooks for all supported cluster types:
    • SLURM cluster tutorial with Monte Carlo and ML training examples
    • PBS/Torque tutorial with bioinformatics and molecular dynamics examples
    • SGE tutorial with optimization and engineering simulation examples
    • Kubernetes tutorial with containerized ML and distributed processing
    • SSH remote execution tutorial with security best practices
    • Complete API demonstration notebook covering all user-facing functions
  • CI Pipeline: Fixed documentation build errors by adding pandoc dependency and correcting table formatting

🆕 New Features

  • Python 3.12 Support: Added official support for Python 3.12 in package classifiers
  • Enhanced Status Reporting: Updated cluster support table to accurately reflect SGE and Kubernetes as "Nearly Ready" instead of "In Progress"

🔄 Technical Improvements

  • Improved ReStructuredText table formatting for better documentation rendering
  • Enhanced notebook integration with Google Colab
  • Streamlined theme configuration for cleaner navigation
  • Better error handling in documentation build process

📦 Installation

pip install clustrix==0.1.1

🔗 Links

- PyPI Package: https://pypi.org/project/clustrix/0.1.1/
- Documentation: https://clustrix.readthedocs.io/
- Tutorial Notebooks: Available in the documentation under "Interactive Notebooks"

📊 What's Working

- ✅ SLURM: Full production support
- ✅ PBS/Torque: Full production support
- ✅ SSH: Full direct execution support
- ⚡ SGE: Job submission works, status monitoring pending
- ⚡ Kubernetes: Job submission works, status monitoring pending

This release primarily focuses on cross-platform compatibility, improved documentation experience, and enhanced user onboarding through comprehensive tutorials.
Assets 2
Loading