Skip to content

Commit 4dde662

Browse files
pbashyal-nmdpjbrelsf2-nmdp
authored andcommitted
Cleanup README (#29)
* Cleanup README * Cleanup README * Cleanup README
1 parent 699fe6d commit 4dde662

File tree

3 files changed

+11
-22
lines changed

3 files changed

+11
-22
lines changed

README.rst

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
===============================
2-
pyARD
2+
py-ard
33
===============================
44

55

@@ -17,19 +17,22 @@ ARD reduction for HLA with python
1717
* Documentation: https://pyard.readthedocs.io.
1818

1919

20-
Install
21-
-------
20+
Install from source
21+
-------------------
2222

2323
.. code-block::
2424
25-
# from source
2625
python3 -m venv venv
2726
source venv/bin/activate
28-
pip install -r requirements.txt
27+
2928
python setup.py install
3029
31-
# from PyPi
32-
pip install pyard
30+
Install from PyPi
31+
-----------------
32+
33+
.. code-block::
34+
35+
pip install py-ard
3336
3437
3538
Example
@@ -61,11 +64,3 @@ Example
6164
# 'B*07:02:01G+B*07:02:01G^A*01:01:01G+A*02:01:01G/A*02:02'
6265
6366
64-
Credits
65-
---------
66-
67-
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
68-
69-
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
70-
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
71-

pyard/pyard.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ def redux_gl(self, glstring: str, redux_type: str) -> str:
435435

436436
def isvalid(self, allele: str) -> str:
437437
"""
438-
Determines valididy of an allele
438+
Determines validity of an allele
439439
440440
:param allele: An HLA allele.
441441
:type: str

requirements.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)