-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
159d01f
commit 38f0949
Showing
2 changed files
with
9 additions
and
9 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 |
---|---|---|
|
@@ -8,7 +8,7 @@ The analysis can be performed by HEIG (will have more in the near future): | |
- Cross-trait genetic correlation between voxels and non-imaging phenotypes | ||
|
||
## Version | ||
- [v1.0.0](https://github.com/Zhiwen-Owen-Jiang/heig/releases/tag/v1.0.0): The initial version of HEIG. | ||
- [v1.1.0](https://github.com/Zhiwen-Owen-Jiang/heig/releases/tag/v1.1.0): Support multi-threading computation; many changes in data format; not compatible with v1.0.0. | ||
|
||
## System Requirements | ||
### OS Requirements | ||
|
@@ -17,14 +17,14 @@ HEIG is supported for macOS and Linux. It has been tested on the following syste | |
- MacOS Sonoma 14.5 | ||
|
||
### Python Dependencies | ||
We implement HEIG on Python 3.11. Specific package dependencies are provided in [requirements](https://github.com/Zhiwen-Owen-Jiang/heig/blob/pub/requirements.txt). | ||
HEIG is implemented in Python 3.11. Specific package dependencies are provided in [requirements](https://github.com/Zhiwen-Owen-Jiang/heig/blob/pub/requirements.txt). | ||
|
||
## Getting Started | ||
First download the [released version](https://github.com/Zhiwen-Owen-Jiang/heig/releases/tag/v1.0.0), unzip it, and navigate to the extracted folder: | ||
First download the [released version](https://github.com/Zhiwen-Owen-Jiang/heig/releases/tag/v1.1.0), unzip it, and navigate to the extracted folder: | ||
``` | ||
wget -O heig-1.0.0.zip https://github.com/Zhiwen-Owen-Jiang/heig/archive/refs/tags/v1.0.0.zip | ||
unzip heig-1.0.0.zip | ||
cd heig-1.0.0 | ||
wget -O heig-1.1.0.zip https://github.com/Zhiwen-Owen-Jiang/heig/archive/refs/tags/v1.1.0.zip | ||
unzip heig-1.1.0.zip | ||
cd heig-1.1.0 | ||
``` | ||
Install [Miniconda](https://docs.anaconda.com/free/miniconda/miniconda-install/) based on your OS, and build the environment and install all dependencies for HEIG. This step may take ~5 minutes. | ||
``` | ||
|
@@ -34,7 +34,7 @@ conda activate heig | |
Or you can do it manually. | ||
|
||
## How to use HEIG | ||
We provided detailed [tutorial](https://github.com/Zhiwen-Owen-Jiang/heig/wiki) for using HEIG. The example data used in the tutorial can be downloaded [here](https://zenodo.org/records/11075259). Common issues are described in the [FAQ](https://github.com/Zhiwen-Owen-Jiang/heig/wiki/FAQ). | ||
We provided detailed [tutorial](https://github.com/Zhiwen-Owen-Jiang/heig/wiki) for using HEIG. The example data used in the tutorial for v1.1.0 can be downloaded [here](https://zenodo.org/records/13770930). Common issues are described in the [FAQ](https://github.com/Zhiwen-Owen-Jiang/heig/wiki/FAQ). | ||
|
||
If that does not work, email Owen Jiang <[email protected]> or <[email protected]>. | ||
|
||
|
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