File tree Expand file tree Collapse file tree 3 files changed +46
-76
lines changed Expand file tree Collapse file tree 3 files changed +46
-76
lines changed Original file line number Diff line number Diff line change @@ -12,29 +12,21 @@ GRiTS is a toolkit for working with coarse-grain systems. It uses [mBuild](https
12
12
### Installation
13
13
#### Using a container
14
14
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:
16
16
``` 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
19
19
```
20
20
21
21
** Or** using [ Docker] ( https://docs.docker.com/ ) , run:
22
22
``` 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
25
25
```
26
26
27
- #### Custom install
27
+ #### Micromamba install
28
28
To create a local environment with [ micromamba] ( https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html ) ), run:
29
29
``` bash
30
- micromamba create -f environment.yml
30
+ micromamba create grits -f environment.yml
31
31
micromamba activate grits
32
32
```
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
- ```
Original file line number Diff line number Diff line change 1
1
[build-system ]
2
- requires = [" setuptools>=45 " , " setuptools_scm[toml]>=6.2 " ]
2
+ requires = [" setuptools>=61.2 " , " versioningit " ]
3
3
build-backend = " setuptools.build_meta"
4
4
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"
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments