-
Notifications
You must be signed in to change notification settings - Fork 9
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
Add ASL fields to config #282
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
1e4a914
Add ASL fields.
tsalo e76304e
Update constants.py
tsalo c903bc7
Merge remote-tracking branch 'upstream/main' into asl
tsalo 0c2a11f
Keep working on docstrings.
tsalo 60b18eb
Update config.py
tsalo d5f7343
Use PathExists and IsFile for param types.
tsalo f975bbe
Remove type from boolean parameter.
tsalo 2358c51
More work.
tsalo 057456e
Update some docs.
tsalo c8201d1
Add support for m0scan, aslcontext, asllabeling.
tsalo 5847146
Update cubids.py
tsalo 9a9db80
Update cubids.py
tsalo 217d3f3
Try fixing PyPi deployment job.
tsalo a86fd30
Merge remote-tracking branch 'upstream/main' into asl
tsalo 196075d
Run black.
tsalo ca648ab
Minor changes.
tsalo 7c95c37
Update cubids.py
tsalo 418eaf8
Update cubids.py
tsalo 0580d74
Address review.
tsalo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -4,8 +4,8 @@ | |
Contributing | ||
============ | ||
|
||
Contributions are welcome, and they are greatly appreciated! Every little bit | ||
helps, and credit will always be given. | ||
Contributions are welcome, and they are greatly appreciated! | ||
Every little bit helps, and credit will always be given. | ||
|
||
You can contribute in many ways: | ||
|
||
|
@@ -26,21 +26,20 @@ If you are reporting a bug, please include: | |
Fix Bugs | ||
~~~~~~~~ | ||
|
||
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help | ||
wanted" is open to whoever wants to implement it. | ||
Look through the GitHub issues for bugs. | ||
Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it. | ||
|
||
Implement Features | ||
~~~~~~~~~~~~~~~~~~ | ||
|
||
Look through the GitHub issues for features. Anything tagged with "enhancement" | ||
and "help wanted" is open to whoever wants to implement it. | ||
Look through the GitHub issues for features. | ||
Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it. | ||
|
||
Write Documentation | ||
~~~~~~~~~~~~~~~~~~~ | ||
|
||
CuBIDS could always use more documentation, whether as part of the | ||
official CuBIDS docs, in docstrings, or even on the web in blog posts, | ||
articles, and such. | ||
CuBIDS could always use more documentation, whether as part of the official CuBIDS docs, | ||
in docstrings, or even on the web in blog posts, articles, and such. | ||
|
||
Submit Feedback | ||
~~~~~~~~~~~~~~~ | ||
|
@@ -59,60 +58,62 @@ Get Started! | |
|
||
Ready to contribute? Here's how to set up `cubids` for local development. | ||
|
||
1. Fork the `cubids` repo on GitHub. | ||
2. Clone your fork locally:: | ||
1. Fork the `cubids` repo on GitHub. | ||
2. Clone your fork locally:: | ||
|
||
$ git clone [email protected]:your_name_here/cubids.git | ||
|
||
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: | ||
3. Install your local copy into a virtualenv. | ||
Assuming you have virtualenvwrapper installed, | ||
this is how you set up your fork for local development:: | ||
|
||
$ mkvirtualenv cubids | ||
$ cd cubids/ | ||
$ python setup.py develop | ||
|
||
4. Create a branch for local development:: | ||
4. Create a branch for local development:: | ||
|
||
$ git checkout -b name-of-your-bugfix-or-feature | ||
|
||
Now you can make your changes locally. | ||
|
||
5. When you're done making changes, check that your changes pass flake8 and the | ||
tests, including testing other Python versions with tox:: | ||
5. When you're done making changes, check that your changes pass flake8 and the | ||
tests, including testing other Python versions with tox:: | ||
|
||
$ flake8 cubids tests | ||
$ python setup.py test or pytest | ||
$ tox | ||
|
||
To get flake8 and tox, just pip install them into your virtualenv. | ||
To get flake8 and tox, just pip install them into your virtualenv. | ||
|
||
6. Commit your changes and push your branch to GitHub:: | ||
6. Commit your changes and push your branch to GitHub:: | ||
|
||
$ git add . | ||
$ git commit -m "Your detailed description of your changes." | ||
$ git push origin name-of-your-bugfix-or-feature | ||
|
||
7. Submit a pull request through the GitHub website. | ||
7. Submit a pull request through the GitHub website. | ||
|
||
Pull Request Guidelines | ||
----------------------- | ||
|
||
Before you submit a pull request, check that it meets these guidelines: | ||
|
||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check | ||
https://circleci.com/gh/PennLINC/CuBIDS | ||
and make sure that the tests pass for all supported Python versions. | ||
1. The pull request should include tests. | ||
2. If the pull request adds functionality, the docs should be updated. Put | ||
your new functionality into a function with a docstring, and add the | ||
feature to the list in README.rst. | ||
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. | ||
Check https://circleci.com/gh/PennLINC/CuBIDS | ||
and make sure that the tests pass for all supported Python versions. | ||
|
||
Tips | ||
---- | ||
|
||
To run a subset of tests:: | ||
|
||
$ cd PATH/TO/LOCAL/CuBIDS/CLONE | ||
$ py.test -sv --pdb tests | ||
$ cd PATH/TO/LOCAL/CuBIDS/CLONE | ||
$ py.test -sv --pdb tests | ||
|
||
|
||
Deploying | ||
|
@@ -122,8 +123,8 @@ A reminder for the maintainers on how to deploy. | |
Make sure all your changes are committed (including an entry in HISTORY.rst). | ||
Then run:: | ||
|
||
$ bump2version patch # possible: major / minor / patch | ||
$ git push | ||
$ git push --tags | ||
$ bump2version patch # possible: major / minor / patch | ||
$ git push | ||
$ git push --tags | ||
|
||
CircleCI will then deploy to PyPI if tests pass. |
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to keep supporting 3.5? Other than pybids the only important dependency is sklearn and I'm not sure how far back they go
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to push forward to 3.9+ at this point, but I'd rather tackle that in a future PR.