summaryrefslogtreecommitdiff
path: root/python-clease.spec
blob: 70aaa3fc1b2ae554b90e85929da981c2d4410947 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
%global _empty_manifest_terminate_build 0
Name:		python-clease
Version:	1.0.6
Release:	1
Summary:	CLuster Expansion in Atomistic Simulation Environment
License:	MPL-2.0
URL:		https://gitlab.com/computationalmaterials/clease/
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/12/4c/97f526c10f302580d117c83fcebe6bb008f87cf4d52f642937bf2341589a/clease-1.0.6.tar.gz
BuildArch:	noarch


%description
# CLEASE

[![coverage](https://gitlab.com/computationalmaterials/clease/badges/master/coverage.svg)](https://gitlab.com/computationalmaterials/clease/)
[![PyPI version](https://badge.fury.io/py/clease.svg)](https://badge.fury.io/py/clease)
[![Conda](https://img.shields.io/conda/vn/conda-forge/clease)](https://anaconda.org/conda-forge/clease)
[![Documentation Status](https://readthedocs.org/projects/clease/badge/?version=latest)](https://clease.readthedocs.io/en/latest/?badge=latest)

CLuster Expansion in Atomic Simulation Environment (CLEASE) is a package that automates the cumbersome setup and construction procedure of cluster expansion (CE). It provides a comprehensive list of tools for specifying parameters for CE, generating training structures, fitting effective cluster interaction (ECI) values and running Monte Carlo simulations. A detailed description of the package can be found in the [documentation](https://clease.readthedocs.io/) and our [paper](https://doi.org/10.1088/1361-648X/ab1bbc).

For information on how to contribute to CLEASE, please see the [contributing](CONTRIBUTING.md) file.

# Installation

Install the CLEASE code by executing

```bash
pip install clease
```

Alternative, CLEASE is also available through anaconda on [conda](https://conda.io) via [conda-forge](https://conda-forge.org/).
We recommend installing CLEASE via conda on windows machines in order to simplify compilations, as pip tends to have
a hard time compiling the C++ code. Install into your conda environment:

```sh
conda install -c conda-forge clease
```
## Graphical User Interface

Clease has a stand-alone jupyter notebook GUI, which is capable of performing most
of the standard CE routines. It can be found [here](https://clease-gui.readthedocs.io).

CLEASE GUI can be installed from PyPI or anaconda using one of the two following commands.

### PyPI

```bash
pip install clease[gui]
```

### Anaconda

```bash
conda install -c conda-forge clease-gui
```

## Development

If you are a developer you might want to install CLEASE by executing the following command in the root folder of the project

```bash
pip install -e .
```

In order to run the tests, the testing dependencies should be installed. They can be installed with the extra
`test` option

```bash
pip install .[test]
```

There is an additional option for development purposes, `dev`, which contains some convenience packages.
All of the extras options can be installed via the `all` option,
i.e.

```bash
pip install .[all]
```

Note, that if you are using `zsh`, you need to [escape the argument](https://stackoverflow.com/a/30539963), e.g.

```bash
pip install '.[all]'
```

## Troubleshooting

If you are running on Mac and get the error

```bash
fatal error: 'ios' file not found
```

try this before installing

```bash
export MACOSX_DEPLOYMENT_TARGET=10.14
```


%package -n python3-clease
Summary:	CLuster Expansion in Atomistic Simulation Environment
Provides:	python-clease
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-clease
# CLEASE

[![coverage](https://gitlab.com/computationalmaterials/clease/badges/master/coverage.svg)](https://gitlab.com/computationalmaterials/clease/)
[![PyPI version](https://badge.fury.io/py/clease.svg)](https://badge.fury.io/py/clease)
[![Conda](https://img.shields.io/conda/vn/conda-forge/clease)](https://anaconda.org/conda-forge/clease)
[![Documentation Status](https://readthedocs.org/projects/clease/badge/?version=latest)](https://clease.readthedocs.io/en/latest/?badge=latest)

CLuster Expansion in Atomic Simulation Environment (CLEASE) is a package that automates the cumbersome setup and construction procedure of cluster expansion (CE). It provides a comprehensive list of tools for specifying parameters for CE, generating training structures, fitting effective cluster interaction (ECI) values and running Monte Carlo simulations. A detailed description of the package can be found in the [documentation](https://clease.readthedocs.io/) and our [paper](https://doi.org/10.1088/1361-648X/ab1bbc).

For information on how to contribute to CLEASE, please see the [contributing](CONTRIBUTING.md) file.

# Installation

Install the CLEASE code by executing

```bash
pip install clease
```

Alternative, CLEASE is also available through anaconda on [conda](https://conda.io) via [conda-forge](https://conda-forge.org/).
We recommend installing CLEASE via conda on windows machines in order to simplify compilations, as pip tends to have
a hard time compiling the C++ code. Install into your conda environment:

```sh
conda install -c conda-forge clease
```
## Graphical User Interface

Clease has a stand-alone jupyter notebook GUI, which is capable of performing most
of the standard CE routines. It can be found [here](https://clease-gui.readthedocs.io).

CLEASE GUI can be installed from PyPI or anaconda using one of the two following commands.

### PyPI

```bash
pip install clease[gui]
```

### Anaconda

```bash
conda install -c conda-forge clease-gui
```

## Development

If you are a developer you might want to install CLEASE by executing the following command in the root folder of the project

```bash
pip install -e .
```

In order to run the tests, the testing dependencies should be installed. They can be installed with the extra
`test` option

```bash
pip install .[test]
```

There is an additional option for development purposes, `dev`, which contains some convenience packages.
All of the extras options can be installed via the `all` option,
i.e.

```bash
pip install .[all]
```

Note, that if you are using `zsh`, you need to [escape the argument](https://stackoverflow.com/a/30539963), e.g.

```bash
pip install '.[all]'
```

## Troubleshooting

If you are running on Mac and get the error

```bash
fatal error: 'ios' file not found
```

try this before installing

```bash
export MACOSX_DEPLOYMENT_TARGET=10.14
```


%package help
Summary:	Development documents and examples for clease
Provides:	python3-clease-doc
%description help
# CLEASE

[![coverage](https://gitlab.com/computationalmaterials/clease/badges/master/coverage.svg)](https://gitlab.com/computationalmaterials/clease/)
[![PyPI version](https://badge.fury.io/py/clease.svg)](https://badge.fury.io/py/clease)
[![Conda](https://img.shields.io/conda/vn/conda-forge/clease)](https://anaconda.org/conda-forge/clease)
[![Documentation Status](https://readthedocs.org/projects/clease/badge/?version=latest)](https://clease.readthedocs.io/en/latest/?badge=latest)

CLuster Expansion in Atomic Simulation Environment (CLEASE) is a package that automates the cumbersome setup and construction procedure of cluster expansion (CE). It provides a comprehensive list of tools for specifying parameters for CE, generating training structures, fitting effective cluster interaction (ECI) values and running Monte Carlo simulations. A detailed description of the package can be found in the [documentation](https://clease.readthedocs.io/) and our [paper](https://doi.org/10.1088/1361-648X/ab1bbc).

For information on how to contribute to CLEASE, please see the [contributing](CONTRIBUTING.md) file.

# Installation

Install the CLEASE code by executing

```bash
pip install clease
```

Alternative, CLEASE is also available through anaconda on [conda](https://conda.io) via [conda-forge](https://conda-forge.org/).
We recommend installing CLEASE via conda on windows machines in order to simplify compilations, as pip tends to have
a hard time compiling the C++ code. Install into your conda environment:

```sh
conda install -c conda-forge clease
```
## Graphical User Interface

Clease has a stand-alone jupyter notebook GUI, which is capable of performing most
of the standard CE routines. It can be found [here](https://clease-gui.readthedocs.io).

CLEASE GUI can be installed from PyPI or anaconda using one of the two following commands.

### PyPI

```bash
pip install clease[gui]
```

### Anaconda

```bash
conda install -c conda-forge clease-gui
```

## Development

If you are a developer you might want to install CLEASE by executing the following command in the root folder of the project

```bash
pip install -e .
```

In order to run the tests, the testing dependencies should be installed. They can be installed with the extra
`test` option

```bash
pip install .[test]
```

There is an additional option for development purposes, `dev`, which contains some convenience packages.
All of the extras options can be installed via the `all` option,
i.e.

```bash
pip install .[all]
```

Note, that if you are using `zsh`, you need to [escape the argument](https://stackoverflow.com/a/30539963), e.g.

```bash
pip install '.[all]'
```

## Troubleshooting

If you are running on Mac and get the error

```bash
fatal error: 'ios' file not found
```

try this before installing

```bash
export MACOSX_DEPLOYMENT_TARGET=10.14
```


%prep
%autosetup -n clease-1.0.6

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-clease -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Tue May 30 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.6-1
- Package Spec generated