Skip to content

v3.1.1

Choose a tag to compare

View all tags
@shchen-idmod shchen-idmod released this 24 Apr 18:05
· 23 commits to main since this release
v3.1.1
847f9fa
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Release Notes for idmtools 3.1.0 + 3.1.1(Tiny hotfix for SSMT)

This release V3.1.0 migrates package distribution from JFrog Artifactory to PyPI and Docker images to GitHub Container Registry, transitions documentation from Sphinx to MkDocs, and delivers a range of bug fixes and cleanup work across all platforms.

📦 Package Distribution & CI/CD Migration

  • Migrated all packages from JFrog Artifactory to PyPI for public distribution.
  • Moved Docker images to GitHub Container Registry (GHCR).
  • Added GitHub Actions workflows to build and publish packages, Docker images, and MkDocs documentation.
  • Removed bump2version tooling in favor of setuptools-scm dynamic versioning.

📚 Documentation Overhaul

  • Fully migrated documentation from Sphinx/RST to MkDocs/Markdown.
  • Fixed all README.md files across packages.
  • Added GitHub Actions workflow to automatically deploy MkDocs to GitHub Pages.

✨ Improvements

  • Explicitly defined all parameters for add_schedule_config and default_add_schedule_config_sweep_callback in COMPS scheduling for clearer API usage.
  • Removed unused platform_task_hooks function and python_version.py file.
  • Cleaned up Makefiles and dev scripts.

🐞 Bug Fixes

  • Fixed Platform(docker_image=<image>) not checking whether the Docker image has been updated before reusing a running container.
  • Fixed inability to build a Singularity image from a GHCR Docker image.
  • Fixed missing name input in task.to_simulation() and Simulation.from_task().
  • Fixed Python command targeting across all platforms.
  • Fixed COMPSPlatform.batch_create not forwarding kwargs to batch_create_items.
  • Fixed SSMT platform working directory issue and simulation tag (v3.1.1)

⚠️ Breaking Changes / Upgrade Notes

  • PyPI Migration:
  • Packages are no longer distributed via JFrog Artifactory. Update any pip configuration or requirements.txt files that reference the JFrog index URL to install directly from PyPI.

Change log:

Feature Request

  • #2727 - Change codebase and release packages from Jfrog to Pypi
  • #2648 - Doc Update: Re-write/update idmtools document (MkDocs)
  • #2711 - Explicitly define parameters for add_schedule_config and default_add_schedule_config_sweep_callback in comps scheduling
  • #2710 - GHA toc-generator.yml update
  • #2716 - Remove bump2version code and package
  • #2713 - Remove no needed function platform_task_hooks and file python_version.py

Bugs

  • #2693 - Platform(docker_image=) does not check if the docker_image has been updated
  • #2712 - Bug: can not build singularity from GHCR docker image
  • #2709 - task.to_simulation missing name input
  • #2717 - Fix python command issue for all platforms
  • #2723 - Bug: when a running container is found, the code reuses it without checking if it was started from the current image version
  • #2632 - Simulation.from_task(task) missing name input
  • #2633 - COMPSPlatform: batch_create didn't pass kwargs to batch_create_items
  • #2732 - SSMT hpc_jobs index error

Configuration

  • #2639 - Remove legacy DTKTools ini file parameters (max_threads, sims_per_thread, max_local_sims)

Documentation

  • #2714 - Fix all README.md file
  • #2715 - Add Github Actions script to deploy mkdoc document

Developer/Test

  • #2718 - Cleanup Makefiles and devscripts
  • #2719 - Integration test with new emod ubuntu runtime docker image
  • #2720 - Build singularity image in COMPS from ubuntu docker image

Other

  • #2649 - Sync/Update idmtools-calibra

Full Changelog: V3.0.0...v3.1.1

Assets 2
Loading