Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Nick Cullen authored Feb 28, 2024
1 parent 00f69e9 commit 454af57
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Advanced Normalization Tools in Python

![img](https://media0.giphy.com/media/OCMGLUo7d5jJ6/200_s.gif)
<br>

[![Coverage Status](https://coveralls.io/repos/github/ANTsX/ANTsPy/badge.svg?branch=master)](https://coveralls.io/github/ANTsX/ANTsPy?branch=master)
<a href='http://antspyx.readthedocs.io/en/latest/?badge=latest'>
Expand All @@ -16,6 +14,7 @@
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/stnava/ANTsPyDocker/master)
[![PubMed](https://img.shields.io/badge/ANTsX_paper-Open_Access-8DABFF?logo=pubmed)](https://pubmed.ncbi.nlm.nih.gov/33907199/)

<br>

## About ANTsPy

Expand All @@ -39,6 +38,8 @@ and wrapping process, please read the extensive [contributors guide](CONTRIBUTIN

If you have any questions or feature requests, feel free to open an issue.

<br>

## Installation

### NOTE: old pip wheels will be deleted!!!
Expand Down Expand Up @@ -105,6 +106,8 @@ ANTsPy docker images, see the (installation tutorial)(https://github.com/ANTsX/A

---

<br>

## ANTsR Comparison

Here is a quick example to show the similarity with <i>ANTsR</i>:
Expand All @@ -129,6 +132,8 @@ mask = get_mask(img)
segs1 = atropos(a=img, m='[0.2,1x1]', c='[2,0]', i='kmeans[3]', x=mask )
```

<br>

## Tutorials

We provide numerous tutorials for new users: [https://github.com/ANTsX/ANTsPy/tree/master/tutorials](https://github.com/ANTsX/ANTsPy/tree/master/tutorials)
Expand All @@ -139,7 +144,9 @@ We provide numerous tutorials for new users: [https://github.com/ANTsX/ANTsPy/tr

[Composite registrations](https://github.com/ANTsX/ANTsPy/blob/master/tutorials/concatenateRegistrations.ipynb)

## other notes on compilation
<br>

## Other notes on compilation

in some cases, you may need some other libraries if they are not already installed eg if cmake says something about
a missing png library or a missing `Python.h` file.
Expand All @@ -151,14 +158,16 @@ sudo apt-get install libpng-dev
sudo apt-get install python3-dev # for python3.x installs
```

## Build documentation
### Build documentation

```
cd docs
sphinx-apidoc -o source/ ../
make html
```

<br>

## References

1. See references at the main [ANTs page](https://github.com/ANTsX/ANTs#boilerplate-ants).
Expand Down

0 comments on commit 454af57

Please sign in to comment.