Skip to content

Commit 13f8298

Browse files
committed
fixing pre-commit
1 parent 5f258e5 commit 13f8298

35 files changed

+1544
-1079
lines changed

.github/workflows/deploy.yml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: aiida-atomistic GitHub Pages Deploy
1+
name: gh-pages-deploy
22
on:
33
push:
44
branches: [main, develop, mkdocs]
@@ -11,7 +11,7 @@ permissions:
1111

1212
# Allow only one concurrent deployment; do NOT cancel in-progress runs.
1313
concurrency:
14-
group: 'pages'
14+
group: pages
1515
cancel-in-progress: false
1616

1717
jobs:
@@ -21,24 +21,24 @@ jobs:
2121
url: ${{ steps.deployment.outputs.page_url }}
2222
runs-on: ubuntu-latest
2323
steps:
24-
- uses: actions/checkout@v4
25-
with:
26-
fetch-depth: 0 # required by git-revision-date-localized
27-
- name: Setup Pages
28-
uses: actions/configure-pages@v4
29-
- uses: actions/setup-python@v5
30-
with:
31-
python-version: '3.11'
32-
- name: Install dependencies
33-
run: |
34-
python -m pip install --upgrade pip
35-
pip install -e .[docs]
36-
- name: Build MkDocs documentation
37-
run: mkdocs build --site-dir ./build
38-
- name: Upload artifact
39-
uses: actions/upload-pages-artifact@v3
40-
with:
41-
path: './build'
24+
- uses: actions/checkout@v4
25+
with:
26+
fetch-depth: 0 # required by git-revision-date-localized
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v4
29+
- uses: actions/setup-python@v5
30+
with:
31+
python-version: '3.11'
32+
- name: Install dependencies
33+
run: |
34+
python -m pip install --upgrade pip
35+
pip install -e .[docs]
36+
- name: Build MkDocs documentation
37+
run: mkdocs build --site-dir ./build
38+
- name: Upload artifact
39+
uses: actions/upload-pages-artifact@v3
40+
with:
41+
path: ./build
4242

4343
deploy:
4444
environment:
@@ -47,6 +47,6 @@ jobs:
4747
runs-on: ubuntu-latest
4848
needs: build
4949
steps:
50-
- name: Deploy to GitHub Pages
51-
id: deployment
52-
uses: actions/deploy-pages@v4
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v4

.github/workflows/publish-on-pypi.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
name: Publish on PyPI
1+
name: pypi-publish
22

33
on:
44
push:
55
tags:
66
# After vMajor.Minor.Patch _anything_ is allowed (without "/") !
7-
- v[0-9]+.[0-9]+.[0-9]+*
7+
- v[0-9]+.[0-9]+.[0-9]+*
88

99
jobs:
1010
publish:
@@ -30,4 +30,4 @@ jobs:
3030
flit publish
3131
env:
3232
FLIT_USERNAME: __token__
33-
FLIT_PASSWORD: ${{ secrets.pypi_token }}
33+
FLIT_PASSWORD: ${{ secrets.pypi_token }}

.pre-commit-config.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ repos:
66
- id: check-added-large-files
77
exclude: uv.lock
88
- id: check-yaml
9-
- id: double-quote-string-fixer
109
- id: end-of-file-fixer
1110
exclude: &exclude_pre_commit_hooks >
1211
(?x)^(

.readthedocs.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
version: 2
22

33
python:
4-
version: "3.8"
4+
version: '3.8'
55
install:
6-
- method: pip
7-
path: .
8-
extra_requirements:
9-
- docs
6+
- method: pip
7+
path: .
8+
extra_requirements:
9+
- docs

docs/how_to/creation_mutation.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -668,4 +668,3 @@ Final structure ready for calculations!
668668
Is alloy: False
669669
Total charge: -1.0
670670
```
671-

docs/how_to/query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ qb.append(
224224
print(f"Structures with charges in ({min_charge}, {max_charge}): {len(qb.all())}")
225225
```
226226

227-
!!! tip
227+
!!! tip
228228
**Using Statistics for Efficient Queries**
229229

230230
Statistical properties enable efficient filtering without loading large arrays:

docs/in_depth/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ Comprehensive explanations of core concepts and advanced topics in `aiida-atomis
2222

2323
[Storage Backends](storage_backends.md)
2424

25-
</div>
25+
</div>

docs/in_depth/properties.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Each `Site` object can have the following properties:
6767

6868
- Type: `str` for pure elements, `list[str]` for alloys
6969
- Example: `'Cu'` or `['Cu', 'Zn']`
70-
70+
7171
- **`position`**: Atomic coordinates in Cartesian space
7272

7373
- Type: `np.ndarray` (shape: `(3,)`)
@@ -381,7 +381,7 @@ print(field_info.json_schema_extra) # {'store_in': 'db'}
381381

382382
# Properties with 'singular_form' are site properties
383383
field_info = StructureBaseModel.model_computed_fields['charges']
384-
print(field_info.json_schema_extra)
384+
print(field_info.json_schema_extra)
385385
# {'store_in': 'repository', 'singular_form': 'charge'}
386386
```
387387

@@ -390,10 +390,10 @@ print(field_info.json_schema_extra)
390390
- **`store_in`**: Where to store the property
391391
- `'db'`: Database attributes (fast queries, size-limited)
392392
- `'repository'`: File repository (large arrays, slower queries)
393-
393+
394394
- **`singular_form`**: Links plural computed property to singular site property
395395
- Example: `charges` (plural) ↔ `charge` (singular)
396-
396+
397397
- **`statistic`**: Statistical aggregation for querying
398398
- `'max'`: Maximum value across all sites
399399
- `'min'`: Minimum value across all sites
@@ -467,4 +467,4 @@ builder.properties.sites.append({'symbol': 'Cu', 'position': [0, 0, 0]}) # OK
467467
# StructureData: immutable (use for storing in database)
468468
structure = StructureData(cell=[[3, 0, 0], [0, 3, 0], [0, 0, 3]], pbc=[True]*3, sites=[...])
469469
structure.properties.sites.append(...) # Error: immutable
470-
```
470+
```

docs/in_depth/storage_backends.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ class StructureBaseModel(BaseModel):
2727
cell: ArrayLike3x3 = Field(
2828
json_schema_extra={"store_in": "db"}
2929
)
30-
30+
3131
# This array goes to repository
3232
@computed_field(json_schema_extra={"store_in": "repository", "singular_form": "position"})
3333
@property
@@ -176,7 +176,7 @@ def my_properties(self) -> np.ndarray:
176176
if all(site.my_property is None for site in self.sites):
177177
return None
178178
return np.array([
179-
site.my_property if site.my_property is not None
179+
site.my_property if site.my_property is not None
180180
else Site.get_default_values()['my_property']
181181
for site in self.sites
182182
])
@@ -266,4 +266,4 @@ Arrays are cached after first load to avoid repeated file I/O:
266266
structure = orm.load_node(pk)
267267
pos1 = structure.properties.positions # Loads from .npz, caches
268268
pos2 = structure.properties.positions # Returns cached (no I/O)
269-
```
269+
```

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ If you use this plugin for your research, please cite the following work:
6060
6161
## Acknowledgements
6262

63-
We acknowledge support from the [NCCR MARVEL](http://nccr-marvel.ch/) funded by the Swiss National Science Foundation and the EU Centre of Excellence ["MaX – Materials Design at the Exascale"](http://www.max-centre.eu/) (Horizon 2020 EINFRA-5, Grant No. 676598).
63+
We acknowledge support from the [NCCR MARVEL](http://nccr-marvel.ch/) funded by the Swiss National Science Foundation and the EU Centre of Excellence ["MaX – Materials Design at the Exascale"](http://www.max-centre.eu/) (Horizon 2020 EINFRA-5, Grant No. 676598).
6464

6565
![marvel](images/MARVEL.png){ width="250" }
66-
![max](images/MaX.png){ width="300" }
66+
![max](images/MaX.png){ width="300" }
6767

6868
[aiida]: http://aiida.net
6969
[aiida-core documentation]: https://aiida.readthedocs.io/projects/aiida-core/en/latest/intro/get_started.html

0 commit comments

Comments
 (0)