Skip to content

Commit a268b86

Browse files
committed
Update README
1 parent fba9222 commit a268b86

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,21 @@ Homebrew will notify you as new versions of `py-ard` are released.
8585

8686
### Install from source
8787

88+
Checkout the `py-ard` source code.
89+
90+
```shell
91+
git clone https://github.com/nmdp-bioinformatics/py-ard.git
92+
cd py-ard
93+
```
94+
95+
Create and activate virtual environment. Install the py-ard dependencies.
96+
8897
```shell
89-
python3 -m venv venv
98+
make venv
99+
90100
source venv/bin/activate
91101

92-
python setup.py install
102+
make install
93103
```
94104

95105
See [Our Contribution Guide](CONTRIBUTING.rst) for open source contribution to `py-ard`.
@@ -103,13 +113,16 @@ it'll throw an Invalid Exception, not silently return an empty result.
103113

104114
#### Initialize `py-ard`
105115

106-
Import `pyard` package.
116+
Import and initialize `pyard` package.
117+
The default initialization is to use the latest version of IPD-IMGT/HLA database.
107118

108119
```python
109120
import pyard
121+
122+
ard = pyard.init()
110123
```
111124

112-
Initialize `ARD` object with a version of IMGT HLA database
125+
Initialize `py-ard` with a particular version of IPD/IMGT-HLA database.
113126

114127
```python
115128
import pyard
@@ -144,13 +157,6 @@ As MAC data changes frequently, you can choose to refresh the MAC code for curre
144157
ard.refresh_mac_codes()
145158
```
146159

147-
The default initialization is to use the latest version of IPD-IMGT/HLA database.
148-
149-
```python
150-
import pyard
151-
152-
ard = pyard.init()
153-
```
154160

155161
You can check the current version of IPD-IMGT/HLA database.
156162

0 commit comments

Comments
 (0)