search

AlexsLemonade / OpenScPCA-analysis

An open, collaborative project to analyze data from the Single-cell Pediatric Cancer Atlas (ScPCA) Portal
Other
1 stars 8 forks source link

Docs: using docker images #538

Closed sjspielman closed 4 days ago

sjspielman commented 6 days ago

Closes #496

This PR adds documentation for using Docker images. To start, I stayed fairly thin on details for how to use Docker in the first place, under the assumption that contributors who actually want to pull images and run in containers have a sense of what they're doing already. I included a note to this end, and I also added a couple more Docker resources (links from training materials).

Let me know if there are any particular details that I glossed over which you think I should mention and/or emphasize more. For example, should I say more about docker run flags or volumes?

One item that this PR does not cover but we should probably open an issue for is running docker images in LSfR, which may be necessary for certain modules depending on their compute needs. Do you agree we should circle back to this?

sjspielman commented 5 days ago

This should now be ready for another look! In addition to other responses to review, I've expanded the discussion of using docker run to cover more ground, and confirmed that the instructions I've written work for the pushed simulate-sce image.