Xboinc release 0.4.3

Xboinc v0.4.3 Release Notes

New Features

• Enhanced JobRetriever to include job metadata
• Check for user subscription status now covers the "broken" case, where a user has provided a directory with no correct writing permissions set for sixtadm

list of PR

• Enhance JobRetriever to include job metadata and User check to see if broken by @carlidel in #26

Full Changelog: v0.4.2...v0.4.3

Xboinc release 0.4.2

Xboinc v0.4.2 Release Notes

New Features

• Dynamic job slicing: added slice_and_add method to JobManager for flexible job slicing and submission.

• Target triplet support: extended build system to support automatic triplet detection on Linux and added explicit support for x86 triplets.

• CMake enhancements:

  • Added -m32 flags for x86-linux and x86-mingw-static configurations.
  • Enhanced generate_executable to handle triplet logic more robustly.

Improvements

• Reduced runtime in test suite execution with smarter skipping when dependencies are missing (e.g., directory availability, account presence).
• Improved error messages for ACL manipulation and permission handling.
• More robust error reporting during compilation.
• Removed redundant double rmtree calls in build folder cleanup.
• Refined test configuration for user management.
• Clarified EOS permission requirements in the README.

Refactoring

• Job management API updated:

  • JobManager renamed to JobSubmitter. ResultRetriever renamed to JobRetriever.
  • Updated examples accordingly.

Bug Fixes

• Fixed a bug in get_job_summary() related to execution time reporting.
• Small fixes in generate_executable to avoid edge-case failures.
• Corrected availability checks for directories in test runs.

List of PR

• Minor improvements by @carlidel in #24
• Release 0.4.2 by @freddieknets in #25

Full Changelog: v0.4.1...v0.4.2

Xboinc release 0.4.1

Xboinc v0.4.1 — Release Notes

This release delivers major improvements to Xboinc’s core functionality, documentation, and developer tooling, while also introducing important new features for job management and build infrastructure.

---

New Features & Enhancements

Job Management

• Added support for ele_start and ele_stop in the executable, allowing partial lattice execution.
• Improved element counting with an enhanced _get_num_elements_from_line to return total element count.
• Added unique job name handling to prevent submission conflicts.
• Included progress bar for file zipping during job submission.
• Expanded JobManager with detailed docstrings, structured logging, validation logic, and better job summary information (including submission status).

Result Handling

• Refactored ResultRetriever to improve result indexing, management, and database queries.
• Replaced get_work_units_by_user with the more flexible query_work_units_by_user.

Database & User Management

• Added user subscription checks and related database functions.
• Introduced list_registered_users with generator-based implementation for cleaner code.
• Improved work unit queries with dev_server filtering support.

---

Build & Dependency Updates

• New build system using CMake and VCPKG for streamlined cross-platform compilation.
• Added xsuite v0.32.3 as a dependency.
• Updated dependencies to include packaging.
• Removed obsolete executables from the repository.
• Adjusted compiler flags.

---

Documentation

• Full Sphinx documentation setup, including configuration, build scripts, and a quickstart guide.
• Added .readthedocs.yaml for seamless ReadTheDocs integration.
• Implemented GitHub Actions workflow to build and deploy documentation to GitHub Pages automatically.
• Rewritten and reorganized README.md for improved clarity, installation steps, and usage examples.
• Added instructions for subscription and job status checks.

---

Test Suite Improvements

• Complete test refactor for better readability, maintainability, and functional coverage of real user workflows.
• Added VCPKG integration checks.
• Expanded user registration/deregistration and job submission/retrieval tests.
• Improved test configuration management and documentation.
• Removed obsolete test_99_clean.py file.

---

Other Changes

• General codebase cleanup: reorganized imports, improved comments, and removed redundant functions.

• Updated copyright year.

• Fixed multiple small bugs, including:

  • query_registered_work_units import and execution.
  • Particle count logging in JobManager.add() for accuracy.
  • Edge-case handling for single-turn lattices (num_turns=1).

---

Version bump: 0.4.1 in pyproject.toml and general.py.

What's Changed

• Release/v0.4.1 by @carlidel in #21
• Release 0.4.1 by @freddieknets in #23

Full Changelog: v0.4.0...v0.4.1

Xboinc release 0.4.0

What's Changed

• Retrieving functionality now present and functional
• Can provide ele_start and ele_stop to submission
• Migrating to Xaux functionality by @carlidel in #18
• Release/v0.4.0 by @carlidel in #19

Full Changelog: v0.3.0...v0.4.0

Xboinc release 0.1.5

What's Changed

• No more compilation at import (default tracker is cached and only compiled when needed)
• Xsuite environment versions are only asserted when needed
• Fixed internal versioning scripts
• Updated examples and tests (tests do not enforce xsuite versions, to make sure issues are found)

Full Changelog: v0.1.4...v0.1.5

Xboinc release 0.1.4

What's Changed

• Easy compilation for Windows targets
• Added retrieve function

Full Changelog: v0.1.3...v0.1.4

Xboinc release 0.1.3

What's Changed

• Important bugfix in executable
• Added tests

Full Changelog: v0.1.2...v0.1.3

Xboinc release 0.1.2

What's Changed

• Quick bugfix: Xrdcp installation only required when copying to/from EOS (this simplifies generating executables on non-standard architectures).

Full Changelog: v0.1.1...v0.1.2

Xboinc release 0.1.1

What's Changed

• Fixed submission script
• Cleaned version script
• Precoded app version and tagname

Full Changelog: v0.1.0...v0.1.1

Xboinc release 0.1.0

What's Changed

• Xboinc version is pinned to exact versions of the other xsuite packages to ensure compatibility between the binaries
• Xboinc won't load if the environment is not exactly the same (it is advised to use virutal environments)
• Executables contain version and test version of binary data
• Creating/loading binary data is tested against the correct versions
• Server-style scripts are collected for easy importing and adaptation on the server

Full Changelog: v0.0.3...v0.1.0