Refactor/reorganize package structure #46
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Major structural changes: - Grouped quantum primitives (gates, pulses, isomorphisms) into primitives/ - Grouped operators (embedded, lifted, direct_sums) into operators/ - Removed redundant "quantum_" prefixes throughout - Simplified directory names: - quantum_systems/ → systems/ - quantum_trajectories/ → trajectories/ - quantum_system_templates/ → templates/ - problem_templates/ → templates/ - Renamed files for clarity: - rollouts.jl → dynamics.jl - quantum_control_problem.jl → problems.jl - piccolo_options.jl → options.jl - animated_plots.jl → animations.jl - quantum_toolbox_plots.jl → quantum_toolbox.jl - Renamed visualizations directories: - pplots/ → visualizations/ - quantum_object_plots/ → quantum_objects/ All module dependencies and loading order have been updated and verified. Package compiles successfully with new structure. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
- Introduced `SamplingProblem` for robust optimization over multiple system variants. - Added `SmoothPulseProblem` for piecewise constant control pulses with smooth transitions. - Created `SplinePulseProblem` for spline-based control pulses, supporting warm-starting. - Expanded the Control module documentation to include new problem templates and their usage. - Enhanced the Quantum module documentation with details on systems, trajectories, and pulses. - Updated the Visualizations module with plotting utilities for analyzing quantum control solutions. - Added tutorials for beginners and experienced users to facilitate learning Piccolo.jl.
Member
|
Looking good, please use docs template to avoid the boilerplate though. ./get_docs_utils.sh and match the file with the right options before it got clobbered @aarontrowbridge |
…rmoniqs/Piccolo.jl into refactor/reorganize-package-structure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request reorganizes and refactors the module structure of the codebase to improve clarity and maintainability. The main changes include renaming and restructuring several submodules and files, consolidating visualization code, and updating include paths to reflect the new organization.
Module and File Structure Refactoring:
src/control/_control.jlfor improved clarity and consistency (e.g.,piccolo_options.jl→options.jl,quantum_control_problem.jl→problems.jl,problem_templates/_problem_templates.jl→templates/_problem_templates.jl, etc.).src/quantum/_quantum.jlto group related functionality (e.g., primitives, operators, systems, dynamics, templates) into dedicated subfolders, improving logical separation and dependency management.Visualization Code Consolidation:
PPlotsmodule and consolidated all visualization-related code under a newVisualizationsmodule, updating includes and usage accordingly insrc/Piccolo.jl. [1] [2]These changes should make the codebase easier to navigate and maintain, with clearer boundaries between different functional areas.