Merge pull request #116 from OSIPI/add_links_to_csv

Add links to csv

Author: stadmill

.github/workflows/ci.yml

@@ -8,6 +8,7 @@ on:
   - pull_request
 
 jobs:
+
   build:
 
     runs-on: ${{ matrix.os }}

.github/workflows/convert_csv.yml

@@ -0,0 +1,37 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions 
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: convert_csv
+
+on:
+  - push
+
+jobs:
+
+  convert_csv_to_md:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        pip install wheel pandas
+        pip install wheel tabulate
+    - name: Run script to convert table
+      run: |
+        python doc/convert_to_md.py
+    - name: Commit md file
+      run: |
+        git add doc/code_contributions_record.md
+        git config --global user.name 'OSIPI'
+        git config --global user.email 'OSIPI@users.noreply.github.com'
+        git diff --exit-code || git commit -am "commit code_contributions_record.md"
+        git push

README.md

@@ -3,14 +3,19 @@
 [![build Actions Status](https://github.com/OSIPI/DCE-DSC-MRI_CodeCollection/workflows/ci/badge.svg)](https://github.com/OSIPI/DCE-DSC-MRI_CodeCollection/actions)
 [![codecov](https://codecov.io/gh/OSIPI/DCE-DSC-MRI_CodeCollection/branch/develop/graph/badge.svg?token=ZR3RPV8Y0B)](https://codecov.io/gh/OSIPI/DCE-DSC-MRI_CodeCollection)
 
+
+
+- [code database with links to source code](doc/code_contributions_record.md)
+- [test-results website](http://osipi.org/DCE-DSC-MRI_TestResults)
+
 The ISMRM Open Science Initiative for Perfusion Imaging ([OSIPI](https://www.osipi.org/)) aims to promote the sharing of perfusion imaging software in order to reduce duplication, improve reproducibility and speed up translation. This **DCE-DSC-MRI_CodeCollection** code library is maintained by [Taskforce 2.3](https://www.osipi.org/task-force-2-3/) of OSIPI and aims to collect, test and share open-source perfusion imaging code for use in research and software development. Code contributions can include modules covering one or more steps within the image processing pipeline, for example T1 mapping, converting signal to concentration and pharmacokinetic modelling. A further aim of OSIPI is to develop a fully tested and harmonised code library, drawing on the contributions within this repository.
 
 A summary of the repository structure is shown below. More detailed information and documentation is located in the repository [wiki](https://github.com/OSIPI/DCE-DSC-MRI_CodeCollection/wiki)
 
 ```
 OSIPI/DCE-DSC-MRI_CodeCollection
 ├── doc
-│    └── code_contributions_record.csv # Overview of code contributions
+│    └── code_contributions_record.md  # Overview of code contributions
 ├── src
 │   └── original                       # Original contributed code organized per contribution
 │       └── DS_BW_VanderBiltUMC_USA
@@ -31,7 +36,8 @@ OSIPI/DCE-DSC-MRI_CodeCollection
 Wiki                                   # Information and guidelines 
 ```
 
-Click [here](https://github.com/OSIPI/DCE-DSC-MRI_CodeCollection/blob/develop/doc/code_contributions_record.csv) for database of code available and testing status 
+Click [here](doc/code_contributions_record.md) for 
+database of code available with links to code. 
 
 The results of the validated code are published on the [test-results website](http://osipi.org/DCE-DSC-MRI_TestResults), which is hosted via a separate [repository](https://github.com/OSIPI/DCE-DSC-MRI_TestResults).