nomad-simulation-apps 0.1.2__tar.gz → 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/PKG-INFO +3 -11
  2. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/README.md +1 -8
  3. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/mkdocs.yml +0 -1
  4. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/pyproject.toml +4 -6
  5. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps/apps/alexandria_dashboard.yaml +29 -28
  6. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/PKG-INFO +3 -11
  7. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/SOURCES.txt +0 -2
  8. nomad_simulation_apps-0.1.2/.github/workflows/cruft-update.yml +0 -75
  9. nomad_simulation_apps-0.1.2/.github/workflows/publish.yml +0 -33
  10. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.cruft.json +0 -0
  11. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.devcontainer/devcontainer.json +0 -0
  12. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.github/dependabot.yml +0 -0
  13. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.github/workflows/actions.yml +0 -0
  14. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.github/workflows/mkdocs-deploy.yml +0 -0
  15. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.gitignore +0 -0
  16. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/.vscode/settings.json +0 -0
  17. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/LICENSE +0 -0
  18. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/MANIFEST.in +0 -0
  19. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/assets/.gitignore +0 -0
  20. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/assets/favicon.png +0 -0
  21. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/assets/nomad-plugin-logo.png +0 -0
  22. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/how_to/contribute.md +0 -0
  23. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/how_to/install_this_plugin.md +0 -0
  24. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/how_to/use_this_plugin.md +0 -0
  25. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/index.md +0 -0
  26. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/reference/references.md +0 -0
  27. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/stylesheets/extra.css +0 -0
  28. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/theme/partials/header.html +0 -0
  29. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/docs/tutorial/alexandria.md +0 -0
  30. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/requirements_docs.txt +0 -0
  31. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/setup.cfg +0 -0
  32. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps/__init__.py +0 -0
  33. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps/apps/__init__.py +0 -0
  34. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps/apps/alexandria_app.py +0 -0
  35. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/dependency_links.txt +0 -0
  36. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/entry_points.txt +0 -0
  37. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/requires.txt +0 -0
  38. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/src/nomad_simulation_apps.egg-info/top_level.txt +0 -0
  39. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/tests/apps/test_alexandria_app.py +0 -0
  40. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/tests/conftest.py +0 -0
  41. {nomad_simulation_apps-0.1.2 → nomad_simulation_apps-0.1.3}/tests/data/.gitkeep +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nomad-simulation-apps
3
- Version: 0.1.2
3
+ Version: 0.1.3
4
4
  Summary: A repository for housing NOMAD's collection of simulation app plugins.
5
5
  Author-email: Martin Kuban <kuban@physik.hu-berlin.de>
6
6
  Maintainer-email: Martin Kuban <kuban@physik.hu-berlin.de>
@@ -207,8 +207,7 @@ License:
207
207
  See the License for the specific language governing permissions and
208
208
  limitations under the License.
209
209
 
210
- Project-URL: Repository, https://github.com/FAIRmat-NFDI/nomad-app-plugins-simulation
211
- Project-URL: Documentation, https://fairmat-nfdi.github.io/nomad-app-plugins-simulation/
210
+ Project-URL: Repository, https://github.com/FAIRmat-NFDI/nomad-simulation-apps
212
211
  Classifier: Intended Audience :: Developers
213
212
  Classifier: Operating System :: OS Independent
214
213
  Classifier: Programming Language :: Python
@@ -234,13 +233,6 @@ A repository for housing NOMAD's collection of simulation app plugins.
234
233
 
235
234
  This `nomad` plugin was generated with `Cookiecutter` along with `@nomad`'s [`cookiecutter-nomad-plugin`](https://github.com/FAIRmat-NFDI/cookiecutter-nomad-plugin) template.
236
235
 
237
- ## Usage
238
-
239
- This package can be installed from PyPI:
240
-
241
- ```sh
242
- pip install nomad-simulation-apps
243
- ```
244
236
 
245
237
  ## Development
246
238
 
@@ -397,7 +389,7 @@ on the [PyPI documentation](https://packaging.python.org/en/latest/tutorials/pac
397
389
 
398
390
  ### Template update
399
391
 
400
- We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
392
+ We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
401
393
 
402
394
  To run the check for updates locally, follow the instructions on [`cruft` website](https://cruft.github.io/cruft/#updating-a-project).
403
395
 
@@ -4,13 +4,6 @@ A repository for housing NOMAD's collection of simulation app plugins.
4
4
 
5
5
  This `nomad` plugin was generated with `Cookiecutter` along with `@nomad`'s [`cookiecutter-nomad-plugin`](https://github.com/FAIRmat-NFDI/cookiecutter-nomad-plugin) template.
6
6
 
7
- ## Usage
8
-
9
- This package can be installed from PyPI:
10
-
11
- ```sh
12
- pip install nomad-simulation-apps
13
- ```
14
7
 
15
8
  ## Development
16
9
 
@@ -167,7 +160,7 @@ on the [PyPI documentation](https://packaging.python.org/en/latest/tutorials/pac
167
160
 
168
161
  ### Template update
169
162
 
170
- We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
163
+ We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
171
164
 
172
165
  To run the check for updates locally, follow the instructions on [`cruft` website](https://cruft.github.io/cruft/#updating-a-project).
173
166
 
@@ -55,5 +55,4 @@ extra_css:
55
55
  - stylesheets/extra.css
56
56
  extra_javascript:
57
57
  - javascript.js
58
- - https://polyfill.io/v3/polyfill.min.js?features=es6
59
58
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
@@ -15,7 +15,7 @@ classifiers = [
15
15
  ]
16
16
  name = "nomad-simulation-apps"
17
17
  description = "A repository for housing NOMAD's collection of simulation app plugins."
18
- dynamic = ["version"]
18
+ version = "0.1.3"
19
19
  readme = "README.md"
20
20
  requires-python = ">=3.9"
21
21
  authors = [
@@ -31,8 +31,7 @@ dependencies = [
31
31
  ]
32
32
 
33
33
  [project.urls]
34
- Repository = "https://github.com/FAIRmat-NFDI/nomad-app-plugins-simulation"
35
- Documentation = "https://fairmat-nfdi.github.io/nomad-app-plugins-simulation/"
34
+ Repository = "https://github.com/FAIRmat-NFDI/nomad-simulation-apps"
36
35
 
37
36
  [project.optional-dependencies]
38
37
  dev = ["ruff", "pytest", "structlog"]
@@ -78,12 +77,13 @@ select = [
78
77
  "UP",
79
78
  # isort
80
79
  "I",
81
- # pylint
80
+ # pylint
82
81
  "PL",
83
82
  ]
84
83
 
85
84
  ignore = [
86
85
  "F403", # 'from module import *' used; unable to detect undefined names
86
+ "PLC0415", # import-outside-top-level
87
87
  ]
88
88
 
89
89
  fixable = ["ALL"]
@@ -111,8 +111,6 @@ package-dir = { "" = "src" }
111
111
  [tool.setuptools.packages.find]
112
112
  where = ["src"]
113
113
 
114
- [tool.setuptools_scm]
115
-
116
114
  [project.entry-points.'nomad.plugin']
117
115
  alexandria_app = "nomad_simulation_apps.apps:alexandria_entry_point"
118
116
 
@@ -34,7 +34,7 @@ widgets:
34
34
  sm:
35
35
  minH: 3
36
36
  minW: 3
37
- h: 8
37
+ h: 9
38
38
  w: 12
39
39
  y: 0
40
40
  x: 0
@@ -74,10 +74,10 @@ widgets:
74
74
  sm:
75
75
  minH: 3
76
76
  minW: 3
77
- h: 4
78
- w: 3
79
- y: 8
80
- x: 6
77
+ h: 9
78
+ w: 12
79
+ y: 36
80
+ x: 0
81
81
  - type: terms
82
82
  show_input: true
83
83
  scale: linear
@@ -114,10 +114,10 @@ widgets:
114
114
  sm:
115
115
  minH: 3
116
116
  minW: 3
117
- h: 4
118
- w: 3
119
- y: 8
120
- x: 3
117
+ h: 9
118
+ w: 12
119
+ y: 18
120
+ x: 0
121
121
  - type: terms
122
122
  show_input: true
123
123
  scale: linear
@@ -154,9 +154,9 @@ widgets:
154
154
  sm:
155
155
  minH: 3
156
156
  minW: 3
157
- h: 4
158
- w: 3
159
- y: 8
157
+ h: 9
158
+ w: 12
159
+ y: 9
160
160
  x: 0
161
161
  - type: histogram
162
162
  show_input: true
@@ -165,8 +165,8 @@ widgets:
165
165
  y:
166
166
  scale: linear
167
167
  x:
168
- search_quantity: results.material.n_elements
169
168
  scale: linear
169
+ search_quantity: results.material.n_elements
170
170
  title: Number of elements
171
171
  layout:
172
172
  xxl:
@@ -200,9 +200,9 @@ widgets:
200
200
  sm:
201
201
  minH: 3
202
202
  minW: 3
203
- h: 4
204
- w: 6
205
- y: 12
203
+ h: 12
204
+ w: 12
205
+ y: 45
206
206
  x: 0
207
207
  - type: terms
208
208
  show_input: true
@@ -240,10 +240,10 @@ widgets:
240
240
  sm:
241
241
  minH: 3
242
242
  minW: 3
243
- h: 4
244
- w: 3
245
- y: 8
246
- x: 9
243
+ h: 9
244
+ w: 12
245
+ y: 27
246
+ x: 0
247
247
  - type: histogram
248
248
  show_input: true
249
249
  autorange: false
@@ -251,10 +251,10 @@ widgets:
251
251
  y:
252
252
  scale: log
253
253
  x:
254
+ scale: linear
254
255
  title: Band gap
255
256
  unit: electron_volt
256
257
  search_quantity: results.properties.electronic.band_gap.value
257
- scale: linear
258
258
  title: Band gap
259
259
  layout:
260
260
  xxl:
@@ -288,10 +288,10 @@ widgets:
288
288
  sm:
289
289
  minH: 3
290
290
  minW: 3
291
- h: 4
292
- w: 6
293
- y: 12
294
- x: 6
291
+ h: 12
292
+ w: 12
293
+ y: 69
294
+ x: 0
295
295
  - type: histogram
296
296
  show_input: true
297
297
  autorange: true
@@ -299,8 +299,8 @@ widgets:
299
299
  y:
300
300
  scale: log
301
301
  x:
302
- search_quantity: results.material.topology.n_atoms
303
302
  title: Number of atoms in the unit cell
303
+ search_quantity: results.material.topology.n_atoms
304
304
  title: Number of atoms
305
305
  layout:
306
306
  xxl:
@@ -334,7 +334,8 @@ widgets:
334
334
  sm:
335
335
  minH: 3
336
336
  minW: 3
337
- h: 4
337
+ h: 12
338
338
  w: 12
339
- y: 16
339
+ y: 57
340
340
  x: 0
341
+
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: nomad-simulation-apps
3
- Version: 0.1.2
3
+ Version: 0.1.3
4
4
  Summary: A repository for housing NOMAD's collection of simulation app plugins.
5
5
  Author-email: Martin Kuban <kuban@physik.hu-berlin.de>
6
6
  Maintainer-email: Martin Kuban <kuban@physik.hu-berlin.de>
@@ -207,8 +207,7 @@ License:
207
207
  See the License for the specific language governing permissions and
208
208
  limitations under the License.
209
209
 
210
- Project-URL: Repository, https://github.com/FAIRmat-NFDI/nomad-app-plugins-simulation
211
- Project-URL: Documentation, https://fairmat-nfdi.github.io/nomad-app-plugins-simulation/
210
+ Project-URL: Repository, https://github.com/FAIRmat-NFDI/nomad-simulation-apps
212
211
  Classifier: Intended Audience :: Developers
213
212
  Classifier: Operating System :: OS Independent
214
213
  Classifier: Programming Language :: Python
@@ -234,13 +233,6 @@ A repository for housing NOMAD's collection of simulation app plugins.
234
233
 
235
234
  This `nomad` plugin was generated with `Cookiecutter` along with `@nomad`'s [`cookiecutter-nomad-plugin`](https://github.com/FAIRmat-NFDI/cookiecutter-nomad-plugin) template.
236
235
 
237
- ## Usage
238
-
239
- This package can be installed from PyPI:
240
-
241
- ```sh
242
- pip install nomad-simulation-apps
243
- ```
244
236
 
245
237
  ## Development
246
238
 
@@ -397,7 +389,7 @@ on the [PyPI documentation](https://packaging.python.org/en/latest/tutorials/pac
397
389
 
398
390
  ### Template update
399
391
 
400
- We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
392
+ We use cruft to update the project based on template changes. A `cruft-update.yml` is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the [instructions](https://github.blog/changelog/2022-05-03-github-actions-prevent-github-actions-from-creating-and-approving-pull-requests/) on how to enable Github Actions to create pull requests.
401
393
 
402
394
  To run the check for updates locally, follow the instructions on [`cruft` website](https://cruft.github.io/cruft/#updating-a-project).
403
395
 
@@ -9,9 +9,7 @@ requirements_docs.txt
9
9
  .devcontainer/devcontainer.json
10
10
  .github/dependabot.yml
11
11
  .github/workflows/actions.yml
12
- .github/workflows/cruft-update.yml
13
12
  .github/workflows/mkdocs-deploy.yml
14
- .github/workflows/publish.yml
15
13
  .vscode/settings.json
16
14
  docs/index.md
17
15
  docs/assets/.gitignore
@@ -1,75 +0,0 @@
1
- # /.github/workflows/cruft-update.yml
2
- name: Update repository with Cruft
3
- permissions:
4
- contents: write
5
- pull-requests: write
6
- on:
7
- schedule:
8
- - cron: "0 14 * * 1" # Every Monday at 2pm (UTC time)
9
- workflow_dispatch:
10
- jobs:
11
- update:
12
- runs-on: ubuntu-latest
13
- strategy:
14
- fail-fast: true
15
- matrix:
16
- include:
17
- - add-paths: .
18
- body: Use this to merge the changes to this repository.
19
- branch: cruft/update
20
- commit-message: "chore: accept new Cruft update"
21
- title: New updates detected with Cruft
22
- - add-paths: .cruft.json
23
- body: Use this to reject the changes in this repository.
24
- branch: cruft/reject
25
- commit-message: "chore: reject new Cruft update"
26
- title: Reject new updates detected with Cruft
27
- steps:
28
- - uses: actions/checkout@v3
29
-
30
- - uses: actions/setup-python@v4
31
- with:
32
- python-version: "3.10"
33
-
34
- - name: Install Cruft
35
- run: pip3 install cruft
36
-
37
- - name: Check if update is available
38
- continue-on-error: false
39
- id: check
40
- run: |
41
- CHANGES=0
42
- if [ -f .cruft.json ]; then
43
- if ! cruft check; then
44
- CHANGES=1
45
- fi
46
- else
47
- echo "No .cruft.json file"
48
- fi
49
-
50
- echo "has_changes=$CHANGES" >> "$GITHUB_OUTPUT"
51
-
52
- - name: Run update if available
53
- if: steps.check.outputs.has_changes == '1'
54
- run: |
55
- git config --global user.email "you@example.com"
56
- git config --global user.name "GitHub"
57
-
58
- cruft update --skip-apply-ask --refresh-private-variables
59
- git restore --staged .
60
-
61
- - name: Create pull request
62
- if: steps.check.outputs.has_changes == '1'
63
- uses: peter-evans/create-pull-request@v4
64
- with:
65
- token: ${{ secrets.GITHUB_TOKEN }}
66
- add-paths: ${{ matrix.add-paths }}
67
- commit-message: ${{ matrix.commit-message }}
68
- branch: ${{ matrix.branch }}
69
- delete-branch: true
70
- branch-suffix: timestamp
71
- title: ${{ matrix.title }}
72
- body: |
73
- This is an autogenerated PR. ${{ matrix.body }}
74
-
75
- [Cruft](https://cruft.github.io/cruft/) has detected updates from the Cookiecutter repository.
@@ -1,33 +0,0 @@
1
- # Upload python package to pypi server and github release.
2
- # Reference: https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
3
-
4
- name: Upload Python Package
5
-
6
- on:
7
- release:
8
- types: [published]
9
-
10
- jobs:
11
- publish-to-pypi:
12
- name: >-
13
- Publish distribution to PyPI
14
- runs-on: ubuntu-latest
15
- environment:
16
- name: pypi
17
- url: https://pypi.org/p/nomad-simulation-apps
18
- permissions:
19
- id-token: write # IMPORTANT: mandatory for trusted publishing
20
- steps:
21
- - uses: actions/checkout@v3
22
- - name: Set up Python
23
- uses: actions/setup-python@v3
24
- with:
25
- python-version: '3.x'
26
- - name: Install dependencies
27
- run: |
28
- python -m pip install --upgrade pip
29
- pip install build
30
- - name: Build package
31
- run: python -m build
32
- - name: Publish package to PyPI
33
- uses: pypa/gh-action-pypi-publish@release/v1