Skip to content

Commit 19f4a69

Browse files
committed
rename project and files to niCHART
1 parent b279574 commit 19f4a69

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+151
-133
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
By using NiBAx, the user agrees to the following license:
1+
By using niCHART, the user agrees to the following license:
22

33
See https://www.med.upenn.edu/cbica/software-agreement-non-commercial.html

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
include NiBAx/plugins/loadsave/MUSE_ROI_Dictionary.csv
1+
include niCHART/plugins/loadsave/MUSE_ROI_Dictionary.csv
22
include README.md

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# [NiBAx] The neuro-imaging brain aging chart
1+
# [niCHART] The neuro-imaging brain aging chart
22

33
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7aadb18130574bd5b85b978cd709fe2c)](https://www.codacy.com/gh/CBICA/NiBAx/dashboard?utm_source=github.com&utm_medium=referral&utm_content=CBICA/NiBAx&utm_campaign=Badge_Grade)
44

55
| :construction:
66
<font size="+1">This software and documentation is under development!
77
Check out up-to-date documentation at
8-
[cbica.github.io/NiBAx/](https://cbica.github.io/NiBAx/) </font> :construction: |
8+
[cbica.github.io/niCHART/](https://cbica.github.io/niCHART/) </font> :construction: |
99
|-----------------------------------------|
1010

11-
The neuro-imaging brain aging chart **[NiBAχ]** is a comprehensive solution to
11+
The neuro-imaging brain aging chart **[niCHART]** is a comprehensive solution to
1212
analyze standard structural and functional brain MRI data across studies.
13-
**[NiBAχ]** and the associated pre-processing tools implement computational
13+
**[niCHART]** and the associated pre-processing tools implement computational
1414
morphometry, functional signal analysis, quality control, statistical
1515
harmonization, data standardization, interactive visualization, and extraction
1616
of expressive imaging signatures.
1717

1818
This `README` is intended for contributors and developers.
1919
User documentation is available at
20-
[cbica.github.io/NiBAx/](https://cbica.github.io/NiBAx/).
20+
[cbica.github.io/niCHART/](https://cbica.github.io/niCHART/).
2121

2222

2323
<figure>
24-
<img src="NiBAx/resources/workflow.gif" alt="[NiBAχ] Demo"/>
25-
<figcaption>Demonstration of the [NiBAχ] graphical user interface.</figcaption>
24+
<img src="niCHART/resources/workflow.gif" alt="[niCHART] Demo"/>
25+
<figcaption>Demonstration of the [niCHART] graphical user interface.</figcaption>
2626
</figure>
2727

2828

@@ -37,23 +37,23 @@ python --version # should be 3.8.8 or newer
3737

3838

3939
### Prepare conda environment
40-
Assuming current working directory is `NiBAx` and containing the source code
41-
cloned from https://github.com/CBICA/NiBAx.git.
40+
Assuming current working directory is `niCHART` and containing the source code
41+
cloned from https://github.com/CBICA/niCHART.git.
4242

4343
Ensure Anaconda is installed. Follow instructions for user's operating system [here](https://docs.anaconda.com/anaconda/install/index.html). After Anaconda has been installed, be sure to exit and reopen any
4444
command line windows to use `conda` command
4545

4646

4747
```shell
48-
conda create -n NiBAx python=3.8.8
49-
conda activate NiBAx
48+
conda create -n niCHART python=3.8.8
49+
conda activate niCHART
5050
python -m pip install --upgrade pip
5151
```
5252

5353

5454
### Prepare environment in Linux (CUBIC)
55-
Assuming current working directory is `NiBAx` and containing the source code
56-
cloned from https://github.com/CBICA/NiBAx.git.
55+
Assuming current working directory is `niCHART` and containing the source code
56+
cloned from https://github.com/CBICA/niCHART.git.
5757

5858
```shell
5959
python -m venv .env
@@ -62,8 +62,8 @@ python -m pip install --upgrade pip
6262
```
6363

6464
### Prepare environment for PowerShell (Windows 10 or 11)
65-
Assuming current working directory is `NiBAx` and containing the source code
66-
cloned from https://github.com/CBICA/NiBAx.git.
65+
Assuming current working directory is `niCHART` and containing the source code
66+
cloned from https://github.com/CBICA/niCHART.git.
6767

6868
```shell
6969
python -m venv .env
@@ -72,21 +72,21 @@ python -m pip install --upgrade pip
7272
```
7373

7474

75-
### Install the [NiBAx] software
76-
To install the [NiBAx], install it in a virtual or conda environment.
75+
### Install the [niCHART] software
76+
To install the [niCHART], install it in a virtual or conda environment.
7777
Depending on the desired version, use one of the following
7878
commands to install it.
7979

8080
```shell
81-
# Editable version for development after cloning https://github.com/CBICA/NiBAx.git
81+
# Editable version for development after cloning https://github.com/CBICA/niCHART.git
8282
python -m pip install -U -e .
8383
poetry install
8484

8585
# Version from pull request (#57 in this example) for testing proposed changes
86-
python -m pip install -U git+https://github.com/CBICA/NiBAx.git@refs/pull/57/head
86+
python -m pip install -U git+https://github.com/CBICA/niCHART.git@refs/pull/57/head
8787

8888
# Main version of toolbox
89-
python -m pip install -U git+https://github.com/CBICA/NiBAx.git
89+
python -m pip install -U git+https://github.com/CBICA/niCHART.git
9090
```
9191

9292

@@ -95,13 +95,13 @@ After proper installation, the standalone graphical user interface can be launch
9595
in the terminal with:
9696

9797
```shell
98-
NiBAx
98+
niCHART
9999
```
100100

101101
The data file can be passed as command line argument `--data_file` as shown below.
102102

103103
```shell
104-
NiBAx --data_file istaging.pkl.gz
104+
niCHART --data_file istaging.pkl.gz
105105
```
106106

107107
## Build executable package for Windows 10/11
@@ -114,12 +114,12 @@ briefcase update
114114
briefcase package
115115
```
116116

117-
The result is an installer `NiBAx.msi` that will install the app in the
117+
The result is an installer `niCHART.msi` that will install the app in the
118118
user's profile. The installation does not require administrator rights.
119119

120120
## Disclaimer
121121
- The software has been designed for research purposes only and has neither been reviewed nor approved for clinical use by the Food and Drug Administration (FDA) or by any other federal/state agency.
122122
- By using NiBAx, the user agrees to the following license: https://www.med.upenn.edu/cbica/software-agreement-non-commercial.html
123123

124124
## Contact
125-
For more information and support, please post on the [Discussions](https://github.com/CBICA/NiBAx/discussions) section or contact <a href="mailto:[email protected]">CBICA Software</a>.
125+
For more information and support, please post on the [Discussions](https://github.com/CBICA/niCHART/discussions) section or contact <a href="mailto:[email protected]">CBICA Software</a>.

docs/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
# -- Project information -----------------------------------------------------
2121

22-
project = 'NiBAχ'
22+
project = 'niCHART'
2323
copyright = '2022, CBICA, University of Pennsylvania'
2424
author = 'Ashish Singh'
2525

@@ -51,7 +51,7 @@
5151
'sphinx.ext.autosectionlabel',
5252
]
5353

54-
autoapi_dirs = ['../NiBAx']
54+
autoapi_dirs = ['../niCHART']
5555

5656
# Add any paths that contain templates here, relative to this directory.
5757
templates_path = ['_templates']
@@ -120,7 +120,7 @@
120120
# -- Options for HTMLHelp output ---------------------------------------------
121121

122122
# Output file base name for HTML help builder.
123-
htmlhelp_basename = 'NiBAxdoc'
123+
htmlhelp_basename = 'niCHARTdoc'
124124

125125

126126
# -- Options for LaTeX output ------------------------------------------------
@@ -147,7 +147,7 @@
147147
# (source start file, target name, title,
148148
# author, documentclass [howto, manual, or own class]).
149149
latex_documents = [
150-
(master_doc, 'NiBAx.tex', 'NiBAx Documentation',
150+
(master_doc, 'niCHART.tex', 'niCHART Documentation',
151151
'Ashish Singh', 'manual'),
152152
]
153153

@@ -157,7 +157,7 @@
157157
# One entry per manual page. List of tuples
158158
# (source start file, name, description, authors, manual section).
159159
man_pages = [
160-
(master_doc, 'NiBAx', 'NiBAx Documentation',
160+
(master_doc, 'niCHART', 'niCHART Documentation',
161161
[author], 1)
162162
]
163163

@@ -168,7 +168,7 @@
168168
# (source start file, target name, title, author,
169169
# dir menu entry, description, category)
170170
texinfo_documents = [
171-
(master_doc, 'NiBAx', 'NiBAx Documentation',
171+
(master_doc, 'niCHART', 'niCHART Documentation',
172172
author, 'Ahmed Abdulkadir', 'The neuro-imaging brain aging chart',
173173
'Miscellaneous'),
174174
]
@@ -281,6 +281,6 @@
281281

282282
html_context['display_github'] = True
283283
html_context['github_user'] = 'CBICA'
284-
html_context['github_repo'] = 'NiBAx'
284+
html_context['github_repo'] = 'niCHART'
285285
html_context['github_version'] = 'main/docs/'
286286

NiBAx/__init__.py renamed to niCHART/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
"""
33
44
Copyright (c) 2018 University of Pennsylvania. All rights reserved.
5-
Use of this source code is governed by license located in license file: https://github.com/CBICA/NiBAx/blob/main/LICENSE
5+
Use of this source code is governed by license located in license file: https://github.com/CBICA/niCHART/blob/main/LICENSE
66
"""
77

88
from PyQt5 import QtCore, QtGui, QtWidgets
99
import argparse
1010
import os, sys
11-
from NiBAx.mainwindow import MainWindow
12-
from NiBAx.NiBAxCmdApp import NiBAxCmdApp
11+
from niCHART.mainwindow import MainWindow
12+
from niCHART.niCHARTCmdApp import niCHARTCmdApp
1313

1414
def main():
15-
parser = argparse.ArgumentParser(description='NiBAx Data Visualization and Preparation')
15+
parser = argparse.ArgumentParser(description='niCHART Data Visualization and Preparation')
1616
parser.add_argument('--data_file', type=str, help='Data file containing data frame.', default=None, required=False)
1717
parser.add_argument('--MUSE_harmonization_model_file', type=str, help='MUSE Harmonization model file.', default=None, required=False)
1818
parser.add_argument('--SPARE_model_file', type=str, help='Model file for SPARE-scores.', default=None, required=False)
@@ -37,13 +37,13 @@ def main():
3737
if((data_file == None) or (MUSE_harmonization_model_file == None) or (output_file == None)):
3838
print("Please provide '--data_file', '--harmonization_model_file' and optionally '--output_file_name' to compute harmonized volumes.")
3939
exit()
40-
App = NiBAxCmdApp()
40+
App = niCHARTCmdApp()
4141
App.LoadData(data_file).Harmonize(MUSE_harmonization_model_file, output_file)
4242
if(compute_spares):
4343
if((data_file == None) or (SPARE_model_file == None) or (output_file == None)):
4444
print("Please provide '--data_file', '--MUSE_harmonization_model_file', '--SPARE_model_file' and optionally '--output_file_name' to compute spares.")
4545
exit()
46-
NiBAxCmdApp().LoadData(data_file).Harmonize(MUSE_harmonization_model_file, output_file).ComputeSpares(SPARE_model_file, output_file)
46+
niCHARTCmdApp().LoadData(data_file).Harmonize(MUSE_harmonization_model_file, output_file).ComputeSpares(SPARE_model_file, output_file)
4747

4848
else:
4949
app = QtWidgets.QApplication(sys.argv)

NiBAx/__main__.py renamed to niCHART/__main__.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
"""
33
44
Copyright (c) 2018 University of Pennsylvania. All rights reserved.
5-
Use of this source code is governed by license located in license file: https://github.com/CBICA/NiBAx/blob/main/LICENSE
5+
Use of this source code is governed by license located in license file: https://github.com/CBICA/niCHART/blob/main/LICENSE
66
"""
77

88
from PyQt5 import QtCore, QtGui, QtWidgets
99
import argparse
1010
import os, sys
11-
from NiBAx.mainwindow import MainWindow
12-
from NiBAx.NiBAxCmdApp import NiBAxCmdApp
11+
from niCHART.mainwindow import MainWindow
12+
from niCHART.niCHARTCmdApp import niCHARTCmdApp
1313

1414
def main():
15-
parser = argparse.ArgumentParser(description='NiBAx Data Visualization and Preparation')
15+
parser = argparse.ArgumentParser(description='niCHART Data Visualization and Preparation')
1616
parser.add_argument('--data_file', type=str, help='Data file containing data frame.', default=None, required=False)
1717
parser.add_argument('--MUSE_harmonization_model_file', type=str, help='MUSE Harmonization model file.', default=None, required=False)
1818
parser.add_argument('--SPARE_model_file', type=str, help='Model file for SPARE-scores.', default=None, required=False)
@@ -39,13 +39,13 @@ def main():
3939
if((data_file == None) or (MUSE_harmonization_model_file == None) or (output_file == None)):
4040
print("Please provide '--data_file', '--harmonization_model_file' and optionally '--output_file_name' to compute harmonized volumes.")
4141
exit()
42-
NiBAxCmdApp.LoadData(data_file)
43-
NiBAxCmdApp().Harmonize(MUSE_harmonization_model_file, output_file)
42+
niCHARTCmdApp.LoadData(data_file)
43+
niCHARTCmdApp().Harmonize(MUSE_harmonization_model_file, output_file)
4444
if(compute_spares):
4545
if((data_file == None) or (SPARE_model_file == None) or (output_file == None)):
4646
print("Please provide '--data_file', '--MUSE_harmonization_model_file', '--SPARE_model_file' and optionally '--output_file_name' to compute spares.")
4747
exit()
48-
NiBAxCmdApp().ComputeSpares(SPARE_model_file,output_file)
48+
niCHARTCmdApp().ComputeSpares(SPARE_model_file,output_file)
4949

5050
else:
5151
app = QtWidgets.QApplication(sys.argv)

NiBAx/aboutdialog.py renamed to niCHART/aboutdialog.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22
"""
33
44
Copyright (c) 2018 University of Pennsylvania. All rights reserved.
5-
Use of this source code is governed by license located in license file: https://github.com/CBICA/NiBAx/blob/main/LICENSE
5+
Use of this source code is governed by license located in license file: https://github.com/CBICA/niCHART/blob/main/LICENSE
66
Author: Ashish Singh
77
"""
88

99
from PyQt5 import QtCore, QtWidgets, uic
1010
import os
11-
from NiBAx.resources import resources
11+
from niCHART.resources import resources
1212

1313
class AboutDialog(QtWidgets.QDialog):
1414
def __init__(self,parent=None):

NiBAx/aboutdialog.ui renamed to niCHART/aboutdialog.ui

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</size>
1818
</property>
1919
<property name="windowTitle">
20-
<string>About NiBAx</string>
20+
<string>About niCHART</string>
2121
</property>
2222
<layout class="QVBoxLayout" name="verticalLayout">
2323
<item>
@@ -52,12 +52,12 @@ p, li { white-space: pre-wrap; }
5252
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:9pt; font-weight:600;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
5353
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:8pt;&quot;&gt;© &lt;/span&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;University of Pennsylvania&lt;/span&gt;&lt;/p&gt;
5454
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:9pt;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
55-
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;NiBAx facilitates preparation of neuro-imaging data for machine learning applications.&lt;/span&gt;&lt;/p&gt;
55+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;niCHART facilitates preparation of neuro-imaging data for machine learning applications.&lt;/span&gt;&lt;/p&gt;
5656
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:9pt;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
57-
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a href=&quot;https://github.com/CBICA/NiBAx&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;https://github.com/CBICA/NiBAx&lt;/span&gt;&lt;/a&gt;&lt;/p&gt;
57+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a href=&quot;https://github.com/CBICA/niCHART&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;https://github.com/CBICA/niCHART&lt;/span&gt;&lt;/a&gt;&lt;/p&gt;
5858
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:9pt;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
5959
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt; font-weight:600;&quot;&gt;License&lt;/span&gt;&lt;/p&gt;
60-
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;By using NiBAx, the user agrees to the following license:&lt;/span&gt;&lt;/p&gt;
60+
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt;By using niCHART, the user agrees to the following license:&lt;/span&gt;&lt;/p&gt;
6161
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;a href=&quot;https://www.med.upenn.edu/cbica/software-agreement-non-commercial.html&quot;&gt;&lt;span style=&quot; font-size:8pt; text-decoration: underline; color:#0000ff;&quot;&gt;https://www.med.upenn.edu/cbica/software-agreement-non-commercial.html&lt;/span&gt;&lt;/a&gt;&lt;span style=&quot; font-size:9pt;&quot;&gt; &lt;/span&gt;&lt;/p&gt;
6262
&lt;p style=&quot;-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; font-size:9pt;&quot;&gt;&lt;br /&gt;&lt;/p&gt;
6363
&lt;p style=&quot; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;&quot;&gt;&lt;span style=&quot; font-size:9pt; font-weight:600;&quot;&gt;Developers:&lt;/span&gt;&lt;/p&gt;
File renamed without changes.

NiBAx/core/baseplugin.py renamed to niCHART/core/baseplugin.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Author: Ashish Singh
44
55
Copyright (c) 2018 University of Pennsylvania. All rights reserved.
6-
Use of this source code is governed by license located in license file: https://github.com/CBICA/NiBAx/blob/main/LICENSE
6+
Use of this source code is governed by license located in license file: https://github.com/CBICA/niCHART/blob/main/LICENSE
77
"""
88

99
from yapsy.IPlugin import IPlugin

0 commit comments

Comments
 (0)