Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contributing and installation documentation #302

Closed
tsalo opened this issue Jun 1, 2023 · 0 comments · Fixed by #231
Closed

Improve contributing and installation documentation #302

tsalo opened this issue Jun 1, 2023 · 0 comments · Fixed by #231
Labels
documentation Improvements or additions to documentation

Comments

@tsalo
Copy link
Member

tsalo commented Jun 1, 2023

Summary

  1. Recommend against installing with pip. We actually haven't pushed to PyPi since 2021.
  2. Link to instructions for installing Docker/Singularity.
    • Note expected image size.
    • Note expected memory requirements.
  3. Add info about workflow for modifying ASLPrep code and using it in Docker/Singularity.
    1. Fork repo to your account.
    2. Make a branch.
    3. Clone to local machine.
    4. Modify in preferred editor.
    5. Pull unstable ASLPrep Docker/Singularity image.
    6. Run Docker/Singularity image with modified code folder mounted to correct location in image.
@tsalo tsalo added the documentation Improvements or additions to documentation label Jun 1, 2023
@tsalo tsalo closed this as completed in #231 Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant