Skip to content

Commit ca13a6f

Browse files
Merge pull request #78 from jennyfothergill/main
Fix versioning
2 parents aa06056 + 71b02bf commit ca13a6f

File tree

3 files changed

+46
-76
lines changed

3 files changed

+46
-76
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,21 @@ GRiTS is a toolkit for working with coarse-grain systems. It uses [mBuild](https
1212
### Installation
1313
#### Using a container
1414

15-
To use GRiTS in a prebuilt container (using [Singularity](https://singularity.lbl.gov/)), run:
15+
To use GRiTS in a prebuilt container (using [Apptainer](https://apptainer.org/)), run:
1616
```bash
17-
singularity pull docker://ghcr.io/cmelab/grits:0.4.1
18-
singularity exec grits_0.4.1.sif bash
17+
apptainer pull docker://ghcr.io/cmelab/grits:latest
18+
apptainer run grits_latest.sif python
1919
```
2020

2121
**Or** using [Docker](https://docs.docker.com/), run:
2222
```bash
23-
docker pull ghcr.io/cmelab/grits:0.4.1
24-
docker run -it cmelab/grits:0.4.1
23+
docker pull ghcr.io/cmelab/grits:latest
24+
docker run -it cmelab/grits:latest
2525
```
2626

27-
#### Custom install
27+
#### Micromamba install
2828
To create a local environment with [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)), run:
2929
```bash
30-
micromamba create -f environment.yml
30+
micromamba create grits -f environment.yml
3131
micromamba activate grits
3232
```
33-
With the `grits` environment active, install the package with pip:
34-
```
35-
pip install .
36-
```
37-
And to test your installation, run:
38-
```
39-
pytest
40-
```

pyproject.toml

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,42 @@
11
[build-system]
2-
requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
2+
requires = ["setuptools>=61.2", "versioningit"]
33
build-backend = "setuptools.build_meta"
44

5-
[tool.setuptools_scm]
6-
write_to = "grits/__version__.py"
5+
[project]
6+
name = "grits"
7+
description = "A toolkit for working with coarse-grained systems"
8+
readme = "README.md"
9+
authors = [{name = "Jenny Fothergill", email = "jennyfothergill@boisestate.edu"}]
10+
license= {text = "GPLv3"}
11+
classifiers=[
12+
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
13+
"Programming Language :: Python",
14+
"Programming Language :: Python :: 3",
15+
]
16+
urls = {Homepage = "https://github.com/cmelab/grits"}
17+
requires-python = ">=3.8"
18+
dynamic = ["version"]
19+
20+
[tool.setuptools]
21+
zip-safe = false
22+
include-package-data = true
23+
license-files = ["LICENSE"]
24+
25+
[tool.setuptools.packages]
26+
find = {namespaces = false}
27+
28+
[tool.setuptools.package-data]
29+
grits = ['"./compounds/*"']
30+
31+
[tool.versioningit]
32+
default-version = "1+unknown"
33+
34+
[tool.versioningit.format]
35+
distance = "{base_version}+{distance}.{vcs}{rev}"
36+
dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
37+
distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
38+
39+
[tool.versioningit.vcs]
40+
method = "git"
41+
match = ["*"]
42+
default-tag = "0.0.0"

setup.py

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

0 commit comments

Comments
 (0)