Repository navigation
docs: add SDK development guide, master image guide and extend getting started - #123
Merged
Merged
Conversation
Describes how to create, locally test, and request a master image (#93).
Describes Hub and Node, the lifecycle of an analysis, communication and where data lives, and adds an at-a-glance overview with entry points per role.
Adds missing terms, a page title and alphabetical ordering.
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configuration
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
Summary
Adds task-oriented user documentation for developing analyses and requesting master images, and fills out the Getting Started section.
User guide
guide/user/sdk-how-to.md): pattern vs. Core SDK, then one section each on getting data (FHIR, files from S3), computing on the node, communication between nodes, and results (final, intermediate, aggregation).guide/user/master-images.md): check existing images, create a new one from an example, test it locally, open a pull request, synchronize the Hub.Admin guide
Getting started
Team
Notes for reviewers
master-imagesrepository and were not executed. Please check the Core SDK messaging example and thedockercommands in particular.masterand to place new images indata/python/use-cases/<name>/.Closes #88
Closes #89
Closes #90
Closes #91
Closes #92
Closes #93