Version 1.1.6.11

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Zitong Lu
+
+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.md

@@ -0,0 +1,77 @@
+![ ](img/logo.jpg " ")
+
+#NeuroRA
+
+**A Python Toolbox of Representational Analysis from Multimodal Neural Data**
+
+## Overview
+**Representational Similarity Analysis (RSA)** has become a popular and effective method to measure the representation of multivariable neural activity in different modes.
+
+**NeuroRA** is an easy-to-use toolbox based on **Python**, which can do some works about **RSA** among nearly all kinds of neural data, including **behavioral, EEG, MEG, fNIRS, sEEG, ECoG, fMRI and some other neuroelectrophysiological data**.
+In addition, users can do **Neural Pattern Similarity (NPS)**, **Spatiotemporal Pattern Similarity (STPS)**, **Inter-Subject Correlation (ISC)**, **Classification-based EEG Decoding** and **a novel cross-temporal RSA (CTRSA)** on **NeuroRA**.
+
+## Installation
+> pip install neurora
+
+## Paper
+
+Lu, Z., & Ku, Y. (2020). NeuroRA: A Python toolbox of representational analysis from multi-modal neural data. Frontiers in Neuroinformatics. 14:563669. doi: 10.3389/fninf.2020.563669
+
+## Website & How to use
+See more details at the [NeuroRA website](https://zitonglu1996.github.io/NeuroRA/).
+
+You can read the [Documentation here](https://neurora.github.io/documentation/index.html) or download the [Tutorial here](https://zitonglu1996.github.io/NeuroRA/neurora/Tutorial.pdf) to know how to use NeuroRA.
+
+## Required Dependencies:
+
+- **[Numpy](http://www.numpy.org)**: a fundamental package for scientific computing.
+- **[SciPy](https://www.scipy.org/scipylib/index.html)**: a package that provides many user-friendly and efficient numerical routines.
+- **[Scikit-learn](https://scikit-learn.org/stable/#)**: a Python module for machine learning.
+- **[Matplotlib](https://matplotlib.org)**: a Python 2D plotting library.
+- **[NiBabel](https://nipy.org/nibabel/)**: a package prividing read +/- write access to some common medical and neuroimaging file formats.
+- **[Nilearn](https://nilearn.github.io/)**: a Python module for fast and easy statistical learning on NeuroImaging data.
+- **[MNE-Python](https://mne.tools/)**: a Python software for exploring, visualizing, and analyzing human neurophysiological data.
+
+## Features
+
+- Calculate the Neural Pattern Similarity (NPS)
+
+- Calculate the Spatiotemporal Neural Pattern Similarity (STPS)
+
+- Calculate the Inter-Subject Correlation (ISC)
+
+- Calculate the Representational Dissimilarity Matrix (RDM)
+
+- Calculate the Cross-Temporal RDM (RDM)
+
+- Calculate the Representational Similarity based on RDMs
+
+- One-Step Realize Representational Similarity Analysis (RSA)
+
+- Conduct Cross-Temporal RSA (CTRSA)
+
+- Conduct Classification-based EEG decoding
+
+- Conduct Statistical Analysis
+
+- Save the RSA result as a NIfTI file for fMRI
+
+- Plot the results
+
+## Demos
+There are several demos for NeuroRA, and you can see them in /demos/.. path (both .py files and .ipynb files are provided).
+
+|   | Run the Demo | View the Demo |
+| - | --- | ---- |
+| Demo 1 | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo1_colab.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo1.ipynb) |
+| Demo 2 | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo2_colab.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo2.ipynb) |
+| Demo 3 | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo3_colab.ipynb) | [![View the notebook](https://img.shields.io/badge/render-nbviewer-orange.svg)](https://nbviewer.jupyter.org/github/ZitongLu1996/NeuroRA/blob/master/demo/NeuroRA_Demo3.ipynb) |
+
+## About NeuroRA
+**Noteworthily**, this toolbox is currently only a **test version**. 
+If you have any question, find some bugs or have some useful suggestions while using, you can email me and I will be happy and thankful to know.
+>My email address: 
+>zitonglu1996@gmail.com / zitonglu@outlook.com
+
+>My personal homepage:
+>https://zitonglu1996.github.io

_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal