-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from getwilds/dev
PROOF v1.1 Updates
- Loading branch information
Showing
2 changed files
with
38 additions
and
9 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,40 @@ | ||
# PROOF (PRoduction On-ramp for Optimization and Feasibility) | ||
PROOF (PRoduction On-ramp for Optimization and Feasibility) is a user-friendly tool designed for managing and executing WDL (Workflow Description Language) workflows using the Cromwell workflow manager. PROOF allows users to: | ||
|
||
- Automate all the backend configurations necessary to run your workflows instantly. | ||
- Validate, troubleshoot, assess performance, and run their workflows all under one roof. | ||
- Refine their workflows before potential transitions to cloud-based infrastructures, providing a ‘proofing’ resource of sorts. | ||
|
||
While it is currently configured to run on the Fred Hutch cluster, it is readily adaptable for local instances and/or instances hosted at other institutions. If interested, please email [email protected] with any questions. | ||
|
||
## Repos: | ||
## Repos | ||
|
||
- [proof-api](https://github.com/FredHutch/proof-api): REST API for PROOF used to automate many/most of the startup/configuration steps of WDL workflow submission via Cromwell. | ||
- Latest release: [v1.0.0](https://github.com/FredHutch/proof-api/releases/tag/v1.0.0) | ||
- Latest release: [v1.1.0](https://github.com/FredHutch/proof-api/releases/tag/v1.1.0) | ||
- [shiny-cromwell](https://github.com/FredHutch/shiny-cromwell): Shiny-based front end for PROOF that provides a point-and-click interface for new users. | ||
- Latest release: [v1.0.0](https://github.com/FredHutch/shiny-cromwell/releases/tag/v1.0.0) | ||
- Latest release: [v1.1.0](https://github.com/FredHutch/shiny-cromwell/releases/tag/v1.1.0) | ||
- [rcromwell](https://github.com/getwilds/rcromwell): R package for interacting with Cromwell servers and the WDL workflows they manage. | ||
- Latest release: [v3.2.1](https://github.com/getwilds/rcromwell/releases/tag/v3.2.1) | ||
- Latest release: [v3.3.0](https://github.com/getwilds/rcromwell/releases/tag/v3.3.0) | ||
- [proofr](https://github.com/getwilds/proofr): R package for interacting with the PROOF API mentioned above. | ||
- Latest release: [v0.2](https://github.com/getwilds/proofr/releases/tag/v0.2) | ||
- Latest release: [v0.3.0](https://github.com/getwilds/proofr/releases/tag/v0.3.0) | ||
- [proofad](https://github.com/getwilds/proofad): collection of scripts used for the user analytics dashboard of PROOF. | ||
- Latest release: [v0.1.0](https://github.com/getwilds/proofad/releases/tag/v0.1.0) | ||
|
||
## Docs: | ||
## Docs | ||
|
||
- Product Description: https://sciwiki.fredhutch.org/datascience/proof/ | ||
- How to Use PROOF: https://sciwiki.fredhutch.org/dasldemos/proof-how-to/ | ||
- PROOF Troubleshooting: https://sciwiki.fredhutch.org/dasldemos/proof-troubleshooting/ | ||
|
||
## Support: | ||
## Support | ||
|
||
For general questions, reach out to the Fred Hutch Data Science Lab (DaSL) at [email protected]. For bugs and/or feature requests, if you know which repository is the most relevant for your bug/feature, please open an issue directly in the corresponding repository. If you are unclear which repository it belongs in, or if the bug/feature spans across multiple repositories, [open an issue](https://github.com/getwilds/proof/issues) in this overarching PROOF repository and the PROOF development team will file issues in the corresponding locations. | ||
|
||
## Contributing: | ||
## Contributing | ||
|
||
If you would like to contribute to this project, see the [contribution guidelines](CONTRIBUTING.md) as well out our [WILDS Contributor Guide](https://getwilds.org/guide/) for more details. | ||
|
||
## License: | ||
## License | ||
|
||
Distributed under the MIT License. See [LICENSE](LICENSE) for details. | ||
|
||
|