Stage Data Implementation and Enhancements#4
Open
TinasheMTapera wants to merge 10 commits into
Open
Conversation
progress
…turing, CLI enhancements, and documentation updates. feat(manifest): restructure manifest for clarity and functionality * Reorganized the manifest structure for better readability and usability. * Added new fields for project details and source configurations. * Updated paths for data directories to reflect new project structure. * Enabled and configured sources for gold mine, globus, and dataverse. * Improved the citizen section for better user identification. feat(cli): enhance CLI commands for manifest handling * Added commands for inspecting and staging data. * Improved error handling and user feedback during CLI operations. * Integrated customs checks for globus and gold mine access. docs(guide): update user guide for new features * Revised sections on manifest creation and staging processes. * Added examples for new CLI commands and their usage. * Clarified the customs validation process for data access. style(notebooks): improve code formatting and readability * Refactored code snippets for better clarity and consistency. * Enhanced comments and documentation within the code.
- Update the ManifestChecker class to improve documentation and clarify parameters. - Add detailed descriptions for methods and attributes. - Ensure structured results are returned for better inspection output. feat(stage): improve staging operations and documentation - Refactor create_stage_directories to clarify its purpose and parameters. - Enhance stage_data_from_globus and stage_data_from_fasrc with detailed docstrings. - Introduce StageResult for summarizing staging outcomes. feat(stagecoach): refine StageCoach class and methods - Update StageCoach to improve manifest issuance and inspection processes. - Add detailed parameter descriptions for methods. - Enhance error handling and user feedback during staging. docs(ui): improve UI message functions documentation - Add docstrings to UI functions for better clarity on usage. - Ensure all message functions have consistent documentation style. docs(checks): enhance checks documentation - Improve docstrings for check functions to clarify their purpose and return types. - Ensure all checks are well-documented for user understanding. docs(customs): clarify customs checks and clearance processes - Add detailed descriptions for clearance checks and their parameters. - Ensure that all customs-related functions are well-documented. docs(issue_manifest): enhance manifest issue process documentation - Improve documentation for the issue_manifest function and its parameters. - Ensure clarity on the process of generating a Stagecoach manifest. docs(manifest_checker): improve documentation for manifest checks - Update the ManifestChecker class documentation to clarify its purpose and functionality. - Ensure all methods are well-documented for better user understanding. docs(stage): enhance staging documentation - Improve documentation for staging functions to clarify their purpose and parameters. - Ensure all staging-related functions are well-documented for user understanding.
* Implement CI workflow to build and publish documentation on push to main * Add preview step for pull requests * Ensure artifacts are uploaded and deployed to GitHub Pages * Enhance CLI command to accept manifest path as an option * Update customs and stage notebooks to reflect changes in globus transfer logic * Improve error handling for missing globus information in manifests
* Update Python version to 3.14 * Introduce `outpost` module for creating a mock Frontier directory * Add `--outpost` CLI flag for manifest creation outside FASRC * Update documentation to reflect new outpost functionality
* Implemented default messages for cases where staging is not requested. * Enhanced user feedback during data staging process.
Fixes #2
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Restructured the manifest for improved clarity and functionality, added new fields for project details, and updated data directory paths. Enhanced CLI commands for better manifest handling, including staging and inspecting data, with improved error handling. Updated documentation to reflect new features and processes.
Fixes #2