Skip to content

Commit cebcffd

Browse files
francescalbfrancescalb
authored
Parse strategy for xyz files using ase and function strategy for converting ase.Atoms to dlite Isntance.
* Updated to oteapi-core v0.1.1
1 parent d12f557 commit cebcffd

33 files changed

Lines changed: 724 additions & 435 deletions

‎.pre-commit-config.yaml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,19 @@ repos:
6666
types: [python]
6767
require_serial: true
6868
files: ^tests/.*$
69+
- id: update-docs-api-reference
70+
name: Update API Reference in Documentation
71+
entry: invoke
72+
args: [create-api-reference-docs, --pre-clean, --pre-commit]
73+
language: python
74+
pass_filenames: false
75+
files: ^oteapi_asmod/.*\.py$
76+
description: Update the API Reference documentation, whenever a Python file is touched in the code base.
77+
- id: update-docs-index
78+
name: Update Landing Page for Documentation
79+
entry: invoke
80+
args: [create-docs-index]
81+
language: python
82+
pass_filenames: false
83+
files: ^README.md$
84+
description: Update the landing page for the documentation if the source file (README.md) is changed.

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+
This file will hold an auto-generated changelog for you project.

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OTE-API plugin for atomistic structures
1+
# OTE-API AtomScale MODels
22

33
An OTE-API Plugin with OTE strategies.
44

@@ -9,12 +9,12 @@ Further reading:
99

1010
## License and copyright
1111

12-
OTE-API plugin for atomistic structures is released under the [MIT license](LICENSE) with copyright © SINTEF.
12+
OTE-API AtomScale MODels is released under the [MIT license](LICENSE) with copyright © SINTEF.
1313

1414
## Acknowledgment
1515

16-
OTE-API plugin for atomistic structures has been created via the [cookiecutter](https://cookiecutter.readthedocs.io/) [template for OTE-API plugins](https://github.com/EMMC-ASBL/oteapi-plugin-template).
16+
OTE-API AtomScale MODels has been created via the [cookiecutter](https://cookiecutter.readthedocs.io/) [template for OTE-API plugins](https://github.com/EMMC-ASBL/oteapi-plugin-template).
1717

18-
OTE-API plugin for atomistic structures has been supported by the following projects:
18+
OTE-API AtomScale MODels has been supported by the following projects:
1919

20-
- __OntoTrans__ (2020-2024) that receives funding from the European Union’s Horizon 2020 Research and Innovation Programme, under Grant Agreement n. 862136.
20+
- **OntoTrans** (2020-2024) that receives funding from the European Union’s Horizon 2020 Research and Innovation Programme, under Grant Agreement n. 862136.

‎docs/CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Changelog
2+
3+
This file will hold an auto-generated changelog for you project.

‎docs/LICENSE.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 SINTEF
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎docs/all_strategies.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# OTE-API AtomScale MODels Strategies
2+
3+
This page provides documentation for the `oteapi_asmod.strategies` submodule, where all the OTE-API AtomScale MODels strategies are located.
4+
5+
These strategies will be available when setting up a server in an environment with oteapi-asmod installed.
6+
7+
::: oteapi_asmod.strategies

‎docs/api_reference/.pages‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
title: "API Reference"

‎docs/api_reference/strategies/.pages‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
title: "strategies"

‎docs/api_reference/strategies/function.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# function
2+
3+
::: oteapi_asmod.strategies.function

‎docs/api_reference/strategies/parse.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# parse
2+
3+
::: oteapi_asmod.strategies.parse

0 commit comments

Comments
 (0)