Skip to content

Updates to Maestro documentation#114

Merged
FrankD412 merged 6 commits intodevelopfrom
documentation_update
Aug 20, 2018
Merged

Updates to Maestro documentation#114
FrankD412 merged 6 commits intodevelopfrom
documentation_update

Conversation

@FrankD412
Copy link
Copy Markdown
Member

This PR is for updates to documentation in general. I've started things off with an update to the README.

I'd like to roll other documentation PRs into this one if possible so that documentation can be updated all at once.

@FrankD412 FrankD412 self-assigned this Jun 30, 2018
@FrankD412
Copy link
Copy Markdown
Member Author

@jsemler -- Let's create PRs to be merged into this one for the Sphinx docs as well.

@FrankD412 FrankD412 changed the title Updates to the README. Updates to Maestro documentation Jun 30, 2018
@FrankD412 FrankD412 added the In Progress Issue or PR that is currently in active development. label Jun 30, 2018
@jsemler
Copy link
Copy Markdown
Collaborator

jsemler commented Jul 3, 2018

@FrankD412 -- Sounds good. I've opened a PR for adding Sphinx documentation.

@FrankD412 FrankD412 force-pushed the documentation_update branch from d5fb671 to 9cea680 Compare August 7, 2018 00:57
* Addition of Quick Start.

* Addition of cancellation status example.

* Corrections to quick start and fix for build errors.
* Start of a LULESH spec that's commented.

* Addition of explanation of step structure.

* Additional comments about steps and dependencies.

* Minor tweaks to comments.

* Addition of parameter block comments.

* Addition of reference to launcher_token YAML

* Tweaks and edits based on feedback.
@FrankD412 FrankD412 merged commit 44d873d into develop Aug 20, 2018
@FrankD412 FrankD412 deleted the documentation_update branch August 20, 2018 21:22
FrankD412 added a commit that referenced this pull request Sep 30, 2018
* Update setup.py to 1.1.3dev

* Updated the getting started documentation

* Added examples for running both lulesh specs

* Flux for Spectrum bugfixes (#116)

* Additional arguments can be passed through batch.

* Correction of the use of extend to append.

* Removal of OMPI vars from env.

* Reversal of env altering.

* Addition of mpi exe to batch.

* Removal of -gpu flag

* Addition of "allocated" to PENDING set.

* Correction of the check_status method call.

* Correction of the Flux import

* Addition of the EnvironmentError to try/catch for check_status.

* Addition of jobid to submission INFO logging.

* Workflow setup fix (#117)

* Fixed a workflow setup issue caused by spaces in the spec name

* Additional dirname formatting

* Refactor of the Study class to breakdown complex APIs (#118)

* Minor docstring correction.

* Change to study setup API to break out workspace creation.

* Update Maestro frontend to use new Study method.

* Renamed Study.setup to be better communicate its functionality.

* Correction to style for configure_study method.

* Moved environment application to add_step.

* Split out acquiring environment elements to its own method.

* Updates to staging checks.

* Renamed _setup_linear and _setup_parameterized from setup to stage for clarity.

* Tweaks and addition of starting to SpectrumFluxAdapter. (#119)

* Updated the LULESH examples to use the LULESH git repository for cloning the repo (#121)

* Add the generation of metadata to Study construction. (#120)

* Addition of method and tweaks to support metadata.

* Addition of call to the method for generating metadata.

* Correction to encode YAML string for py3 compatibility.

* Another attempt at py2-py3 compatible encoding.

* Addition of load_metadata method.

* Additional debug logging for the Flux Spectrum Adapter (#122)

* Additional logging for debugging of the adapter.

* Additional logging.

* Updated Exception.message references to Exception.args (#125)

* Fix status.csv 'State' column writeout. (#127)

* #107 Enhance/return codes (#128)

* #107 Added StudyStatus enumeration
Changed DAG execute_ready_steps to return StudyStatus enum instead of a boolean
conductor and maestro also accept StudyStatus and convert to return value

* #128 fixed issues found in pull request

* #107 added inline comments per PC

* #107 pulling out _check_study_completion
to avoid initial implementaion copy and paste error

* #107 fixed line length issue

* Bugfix that would cause the ExecutionGraph to not update when cancelled. (#131)

* Addition of custom parameter generation when running studies. (#129)

* Command line parameter for custom ParameterGenerators.

* Addition of sample custom parameter generation.

* Correction to missing parameters in SIZE.

* Addition of utility method for importing custom gen py files.

* Correction of syntax.

* Conversion of DOS newlines to Unix.

* Addition of call to check for custom code.

* Correction of a bad docstring.

* Addition of parameter metadata to Maestro.

* Addition of parameters to study metadata.

* Addition of copying of the parameter file to study workspace.

* Correction to a bug for attempting a restart when a restart isn't specified. (#133)

* Initial fix for steps that cannot restart.

* Comments to clarify logic.

* More flexible ExecutionGraph description API and logging of description. (#137)

* Tweaks to how the ExecutionGraph adds descriptions. Added logging.

* Updated study to use the new API and some minor refactor.

* Fixed #134

* Fix to Variable verification. (#138)

 Fixes #123

* Updates to Maestro documentation (#114)

* Updates to the README.

* Added initial getting started example documentation

* Addition of Quick Start documentation. (#130)

* Addition of Quick Start.

* Addition of cancellation status example.

* Corrections to quick start and fix for build errors.

* Addition of a LULESH study specification with heavier comments. (#132)

* Start of a LULESH spec that's commented.

* Addition of explanation of step structure.

* Additional comments about steps and dependencies.

* Minor tweaks to comments.

* Addition of parameter block comments.

* Addition of reference to launcher_token YAML

* Tweaks and edits based on feedback.

* Throttled workflows push steps into the ready queue multiple times. (#136)

* Moved 'mark_submitted' into ExecutionGraph 'execute'

* Conversion of ready_steps deque to use step names.

* Capping the available slots to the length of ready_steps.

* Fixes Popen output to use universal newlines. (#143)

* Addition of a shell util to centralize process creation settings.

* Switch to start_process method.

* Addition of docstring for start_process.

* Update to fix universal newline from false to true.

* Addition of a check for a list and a hard set of shell to False.

* Made conductor launch command a string.

* Fix behavior of start_process for localscriptadapter.

The shell=False flag was not being passed, nor were the env or cwd
arguments being used in the actual function.

* Clean up of start_process

* Cleans up GitDependency errors to not rely on return codes. (#144)

* Addition of a ping method.

* Tweaks to error logging.

* Moved specific existence exception out of return code check.

* Cleanup of some merge characters.

* Tweak for connectivity checking.

* Addition of info to the error message.

* Removal of git return codes since they don't mean anything.

* Update version number to 1.1.3.
FrankD412 added a commit that referenced this pull request Sep 23, 2019
* Updates to the README.

* Added initial getting started example documentation

* Addition of Quick Start documentation. (#130)

* Addition of Quick Start.

* Addition of cancellation status example.

* Corrections to quick start and fix for build errors.

* Addition of a LULESH study specification with heavier comments. (#132)

* Start of a LULESH spec that's commented.

* Addition of explanation of step structure.

* Additional comments about steps and dependencies.

* Minor tweaks to comments.

* Addition of parameter block comments.

* Addition of reference to launcher_token YAML

* Tweaks and edits based on feedback.
FrankD412 added a commit that referenced this pull request Jan 22, 2020
* Updates to the README.

* Added initial getting started example documentation

* Addition of Quick Start documentation. (#130)

* Addition of Quick Start.

* Addition of cancellation status example.

* Corrections to quick start and fix for build errors.

* Addition of a LULESH study specification with heavier comments. (#132)

* Start of a LULESH spec that's commented.

* Addition of explanation of step structure.

* Additional comments about steps and dependencies.

* Minor tweaks to comments.

* Addition of parameter block comments.

* Addition of reference to launcher_token YAML

* Tweaks and edits based on feedback.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation In Progress Issue or PR that is currently in active development.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants