Merge branch 'main' of https://github.com/mtorabi59/dFC

.github/workflows/validate_cff.yml

@@ -0,0 +1,24 @@
+---
+name: validate CITATION.cff
+
+on:
+    push:
+        branches: ['*']
+        paths:
+        -   CITATION.cff
+        -   .github/workflows/validate_cff.yml
+    pull_request:
+        branches: ['*']
+        paths:
+        -   CITATION.cff
+        -   .github/workflows/validate_cff.yml
+
+jobs:
+    validate_cff:
+        runs-on: ubuntu-latest
+        steps:
+        -   uses: actions/checkout@v4
+        -   name: Check whether the citation metadata from CITATION.cff is valid
+            uses: citation-file-format/[email protected]
+            with:
+                args: --validate

CITATION.cff

@@ -0,0 +1,33 @@
+cff-version: 1.2.0
+
+title: "pydfc"
+
+version: 1.0.2
+
+abstract:
+  "An implementation of several well-known dynamic Functional Connectivity assessment methods."
+
+message: "If you use this software, please cite it as below."
+
+repository-code: "https://github.com/neurodatascience/dFC.git"
+
+
+contact:
+  - affiliation: "McGill University, Québec, Canada"
+    email: [email protected]
+    family-names: Torabi
+    given-names: Mohammad
+
+authors:
+  - family-names: "Torabi"
+    given-names: "Mohammad"
+    orcid: "https://orcid.org/0000-0002-4429-8481"
+    affiliation: Biological and Biomedical Engineering program, McGill University, Québec, Canada"
+
+license: MIT
+
+keywords:
+  - dynamic functional connectivity
+  - analytical flexibility
+  - neuroimaging
+  - reproducibility

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mohammad Torabi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.rst

@@ -1,5 +1,5 @@
-.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10211966.svg
-    :target: https://doi.org/10.5281/zenodo.10211966
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10161176.svg
+    :target: https://zenodo.org/doi/10.5281/zenodo.10161176
 
 pydfc
 =======