Skip to content

Commit 76d6c1a

Browse files
authored
Merge pull request #1 from graeter-group/patch_readme
added gitignore and updated readme instructions
2 parents 87da516 + 1fec2d3 commit 76d6c1a

3 files changed

Lines changed: 20 additions & 5 deletions

File tree

.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
*.egg-info
2+
*/__pycache__
3+
*.log
4+
build/
5+
.hypothesis/

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ The following tutorials are avaiable as Google Colab notebooks and hence do not
2323
pip install gmx-top4py
2424
```
2525

26-
### From TestPyPI
27-
```bash
28-
pip install --index-url https://test.pypi.org/simple --extra-index-url https://pypi.org/simple gmx-top4py
29-
```
3026
### From source via uv
3127
Clone repository and move into
3228
```bash
@@ -45,3 +41,17 @@ Verify install by running the tests
4541
```bash
4642
pytest tests
4743
```
44+
45+
### From source via conda/pip
46+
Clone repository and move into
47+
```bash
48+
git clone git@github.com:graeter-group/gmx-top4py.git
49+
cd gmx-top4py
50+
conda create -n gmx-top4py python -y
51+
conda activate gmx-top4py
52+
pip install -e '.[dev]' # install with dev dependencies
53+
```
54+
Verify install by running the tests
55+
```bash
56+
pytest tests
57+
```

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ name = "gmx-top4py"
77
version = "0.1.1"
88
description = "A Python library to parse GROMACS topology files and alter associated force fields parameters."
99
license-files = ["LICEN[CS]E*"]
10-
authors = [{ name = "graeter-group", email = "ak-graeter@mpip-mainz.mpg.de"}]
10+
authors = [{ name = "graeter-group"}]
1111
classifiers = [
1212
"Programming Language :: Python :: 3",
1313
"Operating System :: OS Independent",

0 commit comments

Comments
 (0)