-
Notifications
You must be signed in to change notification settings - Fork 1
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 #4 from BRAIN-TO/joss_review_response
Joss review response
- Loading branch information
Showing
62 changed files
with
30,045 additions
and
3,475 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| name: CI | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
| - joss_review_response | ||
| tags: ['*'] | ||
| pull_request: | ||
| concurrency: | ||
| # Skip intermediate builds: always. | ||
| # Cancel intermediate builds: only if it is a pull request build. | ||
| group: ${{ github.workflow }}-${{ github.ref }} | ||
| cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }} | ||
| jobs: | ||
| test: | ||
| name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }} | ||
| runs-on: ${{ matrix.os }} | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| version: | ||
| - '1.9' | ||
| - '1.10' | ||
| os: | ||
| - ubuntu-latest | ||
| arch: | ||
| - x64 | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: ${{ matrix.version }} | ||
| arch: ${{ matrix.arch }} | ||
| - uses: julia-actions/cache@v1 | ||
| - uses: julia-actions/julia-buildpkg@v1 | ||
| - uses: julia-actions/julia-runtest@v1 | ||
| - uses: julia-actions/julia-processcoverage@v1 | ||
| - uses: codecov/codecov-action@v2 | ||
| with: | ||
| files: lcov.info |
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 |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| name: CompatHelper | ||
| on: | ||
| schedule: | ||
| - cron: 0 0 * * * | ||
| workflow_dispatch: | ||
| permissions: | ||
| contents: write | ||
| pull-requests: write | ||
| jobs: | ||
| CompatHelper: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Check if Julia is already available in the PATH | ||
| id: julia_in_path | ||
| run: which julia | ||
| continue-on-error: true | ||
| - name: Install Julia, but only if it is not already available in the PATH | ||
| uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1' | ||
| arch: ${{ runner.arch }} | ||
| if: steps.julia_in_path.outcome != 'success' | ||
| - name: "Add the General registry via Git" | ||
| run: | | ||
| import Pkg | ||
| ENV["JULIA_PKG_SERVER"] = "" | ||
| Pkg.Registry.add("General") | ||
| shell: julia --color=yes {0} | ||
| - name: "Install CompatHelper" | ||
| run: | | ||
| import Pkg | ||
| name = "CompatHelper" | ||
| uuid = "aa819f21-2bde-4658-8897-bab36330d9b7" | ||
| version = "3" | ||
| Pkg.add(; name, uuid, version) | ||
| shell: julia --color=yes {0} | ||
| - name: "Run CompatHelper" | ||
| run: | | ||
| import CompatHelper | ||
| CompatHelper.main() | ||
| shell: julia --color=yes {0} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }} | ||
| # COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }} |
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 |
|---|---|---|
|
|
@@ -3,3 +3,4 @@ LocalPreferences.toml | |
| GIRFReco.code-workspace | ||
| docs/build/ | ||
| docs/src/generated/ | ||
| .vscode/ | ||
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 |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| # Contributing to GIRFReco.jl | ||
| We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: | ||
|
|
||
| - Reporting a bug | ||
| - Discussing the current state of the code | ||
| - Submitting a fix | ||
| - Proposing new features | ||
|
|
||
| ## We Develop with Github | ||
| We use github to host code, to track issues and feature requests, as well as accept pull requests. | ||
|
|
||
| We actively welcome your pull requests: | ||
|
|
||
| 1. Fork or clone the repo and create your branch from `main`. | ||
| 2. If you've added code that should be tested, add tests. | ||
| 3. Add docstrings to facilitate our generated documentation. | ||
| 4. Ensure your (and our) tests pass | ||
| 5. Post the PR or file an issue and we will work with you | ||
|
|
||
| ## Any contributions you make will be under the BSD 3-Clause Software License | ||
| In short, when you submit code changes, your submissions are understood to be under the same [BSD 3-Clause License | ||
| ](https://choosealicense.com/licenses/bsd-3-clause/) that covers the project. Feel free to contact the maintainers if that's a concern. | ||
|
|
||
| ## Report bugs using Github's [issues](https://github.com/BRAIN-TO/GIRFReco.jl/issues) | ||
| We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/BRAIN-TO/GIRFReco.jl/issues/new/choose); it's that easy! | ||
|
|
||
| ## Write bug reports with detail, background, and sample code | ||
|
|
||
| **Great Bug Reports** tend to have: | ||
|
|
||
| - A quick summary and/or background | ||
| - Steps to reproduce | ||
| - Be specific! | ||
| - Give sample code if you can, a minimum working example (MWE) is best but we understand MRI involves complicated and large data | ||
| - What you expected would happen | ||
| - What actually happens | ||
| - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) | ||
|
|
||
| People *love* thorough bug reports. I'm not even kidding. | ||
|
|
||
| ## Use a Consistent Coding Style | ||
| * We (mostly) use Julia [Blue](https://github.com/invenia/BlueStyle) | ||
| * It would be great if you did as well | ||
|
|
||
| ## License | ||
| By contributing, you agree that your contributions will be licensed under its BSD 3-Clause License. | ||
|
|
||
| ## References | ||
| This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) |
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 |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [deps] | ||
| Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" | ||
| FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549" | ||
| Flux = "587475ba-b771-5e3f-ad9e-33799f191a9c" | ||
| GIRFReco = "cf1bd817-9e2d-403d-b1e7-15ef5a867bae" | ||
| HDF5 = "f67ccb44-e63f-5c2f-98bd-6dc0ccc4ba2f" | ||
| ImageTransformations = "02fcd773-0e25-5acc-982a-7f6622650795" | ||
| ImageUtils = "8ad4436d-4835-5a14-8bce-3ae014d2950b" | ||
| Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" | ||
| MRIBase = "f7771a9a-6e57-4e71-863b-6e4b6a2f17df" | ||
| MRICoilSensitivities = "c57eb701-aafc-44a2-a53c-128049758959" | ||
| MRIFiles = "5a6f062f-bf45-497d-b654-ad17aae2a530" | ||
| MRIGradients = "6ea382ba-d04a-44a2-b811-544bd2aee867" | ||
| MRIReco = "bdf86e05-2d2b-5731-a332-f3fe1f9e047f" | ||
| MRISimulation = "8988da37-ea20-4fa6-9af7-8a6f6f9a8970" | ||
| PlotlyJS = "f0f68f2c-4968-5e81-91da-67840de0976a" | ||
| Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" | ||
| Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7" | ||
| RegularizedLeastSquares = "1e9c538a-f78c-5de5-8ffb-0b6dbe892d23" | ||
|
|
||
| [compat] | ||
| MRIReco = "0.7.1" |
Oops, something went wrong.