-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into in_place_ntoh
- Loading branch information
Showing
30 changed files
with
1,315 additions
and
232 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,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
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,23 @@ | ||
| on: [push] | ||
|
|
||
| jobs: | ||
| paper: | ||
| runs-on: ubuntu-latest | ||
| name: Paper Draft | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
| - name: Build draft PDF | ||
| uses: openjournals/openjournals-draft-action@master | ||
| with: | ||
| journal: joss | ||
| # This should be the path to the paper within your repo. | ||
| paper-path: paper/paper.md | ||
| - name: Upload | ||
| uses: actions/upload-artifact@v1 | ||
| with: | ||
| name: paper | ||
| # This is the output path where Pandoc will write the compiled | ||
| # PDF. Note, this should be the same directory as the input | ||
| # paper.md | ||
| path: paper/paper.pdf |
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,13 @@ | ||
| @article{ | ||
| UnROOT-2022, | ||
| doi = {10.21105/joss.04452}, | ||
| url = {https://doi.org/10.21105/joss.04452}, | ||
| year = {2022}, | ||
| publisher = {The Open Journal}, | ||
| volume = {7}, | ||
| number = {76}, | ||
| pages = {4452}, | ||
| author = {Tamás Gál and Jerry (Jiahong) Ling and Nick Amin}, | ||
| title = {UnROOT: an I/O library for the CERN ROOT file format written in Julia}, | ||
| journal = {Journal of Open Source Software} | ||
| } |
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,18 @@ | ||
| cff-version: 1.2.0 | ||
| message: "Cite this paper whenever you use this package" | ||
| authors: | ||
| - family-names: "Gál" | ||
| given-names: "Tamás" | ||
| orcid: "https://orcid.org/0000-0001-7821-8673" | ||
| - family-names: "Ling" | ||
| given-names: "Jerry" | ||
| orcid: "https://orcid.org/0000-0002-3359-0380" | ||
| - family-names: "Amin" | ||
| given-names: "Nick" | ||
| orcid: "https://orcid.org/0000-0003-2560-0013" | ||
| title: "UnROOT: an I/O library for the CERN ROOT file format written in Julia" | ||
| version: "v1" | ||
| license: "MIT" | ||
| doi: "10.21105/joss.04452" | ||
| date-released: 2021-10-11 | ||
| url: "https://github.com/JuliaHEP/UnROOT.jl/" |
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,6 @@ | ||
| UnROOT.jl Standards | ||
| ========================= | ||
|
|
||
| We abide by the larger Julia Communities Code of Conduct (CoC). You can find that CoC listed here: https://julialang.org/community/standards/ | ||
|
|
||
| If you have a conflict or concern that requires resolution, please contact the [Julia Community Stewards](https://julialang.org/community/stewards/). |
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,39 @@ | ||
| # Contribute to UnROOT.jl | ||
|
|
||
| To make your first PR to this repo: | ||
|
|
||
| 1. Have basic understanding of **Git**. The tutorial [Making a first Julia pull request](https://kshyatt.github.io/post/firstjuliapr/) could be helpful for learning both git and how to contribute to the Julia language projects. | ||
| 2. Set up your local environment. We recommend use `Revise.jl` workflow. | ||
| 3. Familiarise yourself with the source code. See [Source code organization](#source-code-organization). | ||
| 4. Make changes & test them & submit PR. | ||
|
|
||
| ## Contribution example ideas | ||
|
|
||
| ### Core functionality | ||
| 1. Parsing more ROOT types | ||
| 2. Implement writing `.root` files | ||
|
|
||
| #### Help Wanted Issues | ||
| One of the best ways to contribute is by looking at issues labelled [help wanted](https://github.com/JuliaHEP/UnROOT.jl/labels/help%20wanted). These issues are not always beginner-friendly. However, you are welcome to [ask clarifying questions](#get-help) or just browse | ||
| help wanted issues to see if there is anything that seems interesting to help with. | ||
|
|
||
| ### Write tutorials | ||
| We can always use more tutorial on how to use UnROOT.jl efficiently and with other visualization or statistics tools in Julia for doing | ||
| HEP. | ||
|
|
||
| ## Contribution guidelines | ||
| - We use the GitHub issue page for any bug filing or feature request, feel free to use them. | ||
| - For usage related discussion, feel free to use [HEP tag on Julia discourse](https://discourse.julialang.org/tag/hep) or join | ||
| our [mailist](https://groups.google.com/g/julia-hep). | ||
|
|
||
| ### source code organization | ||
|
|
||
| The following table shows how the code is organized: | ||
|
|
||
| | Directory | Contents | | ||
| | ------------- | ------------- | | ||
| | docs | Documentation| | ||
| | paper | JOSS paper | | ||
| | src | Source code | | ||
| | test | Test suites | | ||
| | test/samples | .root files for tests | |
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
Oops, something went wrong.