fiab-core 0.0.0__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.
- fiab_core-0.0.0/.python-version +1 -0
- fiab_core-0.0.0/LICENSE +201 -0
- fiab_core-0.0.0/PKG-INFO +14 -0
- fiab_core-0.0.0/README.md +1 -0
- fiab_core-0.0.0/justfile +4 -0
- fiab_core-0.0.0/pyproject.toml +42 -0
- fiab_core-0.0.0/setup.cfg +4 -0
- fiab_core-0.0.0/src/fiab_core/__init__.py +0 -0
- fiab_core-0.0.0/src/fiab_core/_version.py +34 -0
- fiab_core-0.0.0/src/fiab_core/artifacts.py +54 -0
- fiab_core-0.0.0/src/fiab_core/fable.py +105 -0
- fiab_core-0.0.0/src/fiab_core/plugin.py +53 -0
- fiab_core-0.0.0/src/fiab_core/tools/__init__.py +0 -0
- fiab_core-0.0.0/src/fiab_core/tools/blocks.py +74 -0
- fiab_core-0.0.0/src/fiab_core/tools/plugins.py +53 -0
- fiab_core-0.0.0/src/fiab_core.egg-info/PKG-INFO +14 -0
- fiab_core-0.0.0/src/fiab_core.egg-info/SOURCES.txt +19 -0
- fiab_core-0.0.0/src/fiab_core.egg-info/dependency_links.txt +1 -0
- fiab_core-0.0.0/src/fiab_core.egg-info/requires.txt +2 -0
- fiab_core-0.0.0/src/fiab_core.egg-info/top_level.txt +1 -0
- fiab_core-0.0.0/tests/test_base.py +16 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12
|
fiab_core-0.0.0/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright 2024 European Centre for Medium-Range Weather Forecasts
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
fiab_core-0.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fiab-core
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: Weather Forecast in a Box, core schemata and definitions
|
|
5
|
+
Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Requires-Python: >=3.11
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Requires-Dist: pydantic
|
|
11
|
+
Requires-Dist: earthkit-workflows
|
|
12
|
+
Dynamic: license-file
|
|
13
|
+
|
|
14
|
+
Consult the main readme of [forecast-in-a-box](../../README.md), and documentation of [plugins](../../docs/plugins.md).
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Consult the main readme of [forecast-in-a-box](../../README.md), and documentation of [plugins](../../docs/plugins.md).
|
fiab_core-0.0.0/justfile
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
build-backend = "setuptools.build_meta"
|
|
3
|
+
|
|
4
|
+
requires = [ "setuptools>=80", "setuptools-scm[toml]>=6.2" ]
|
|
5
|
+
|
|
6
|
+
[project]
|
|
7
|
+
name = "fiab-core"
|
|
8
|
+
description = "Weather Forecast in a Box, core schemata and definitions"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = "Apache-2.0"
|
|
11
|
+
license-files = [ "LICENSE" ]
|
|
12
|
+
authors = [
|
|
13
|
+
{ name = "European Centre for Medium-Range Weather Forecasts (ECMWF)", email = "software.support@ecmwf.int" },
|
|
14
|
+
]
|
|
15
|
+
requires-python = ">=3.11"
|
|
16
|
+
|
|
17
|
+
dynamic = [ "version" ]
|
|
18
|
+
|
|
19
|
+
dependencies = [
|
|
20
|
+
"pydantic",
|
|
21
|
+
"earthkit-workflows", # NOTE technically we would need just cascade.low.core and some fluent.core, not the whole runtime -- possibly split down there as well
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[dependency-groups]
|
|
25
|
+
dev = [
|
|
26
|
+
"ty==0.0.2",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
[tool.setuptools_scm]
|
|
30
|
+
version_file = "src/fiab_core/_version.py"
|
|
31
|
+
write_to_template = '''# Do not change! Do not track in version control!
|
|
32
|
+
__version__ = "{version}"
|
|
33
|
+
'''
|
|
34
|
+
local_scheme = "no-local-version"
|
|
35
|
+
root = ".."
|
|
36
|
+
fallback_version = "0.0.0"
|
|
37
|
+
tag_regex = '^[vd](?P<version>\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$'
|
|
38
|
+
|
|
39
|
+
[tool.ruff]
|
|
40
|
+
line-length = 140
|
|
41
|
+
|
|
42
|
+
lint.ignore = [ "E731" ]
|
|
File without changes
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# file generated by setuptools-scm
|
|
2
|
+
# don't change, don't track in version control
|
|
3
|
+
|
|
4
|
+
__all__ = [
|
|
5
|
+
"__version__",
|
|
6
|
+
"__version_tuple__",
|
|
7
|
+
"version",
|
|
8
|
+
"version_tuple",
|
|
9
|
+
"__commit_id__",
|
|
10
|
+
"commit_id",
|
|
11
|
+
]
|
|
12
|
+
|
|
13
|
+
TYPE_CHECKING = False
|
|
14
|
+
if TYPE_CHECKING:
|
|
15
|
+
from typing import Tuple
|
|
16
|
+
from typing import Union
|
|
17
|
+
|
|
18
|
+
VERSION_TUPLE = Tuple[Union[int, str], ...]
|
|
19
|
+
COMMIT_ID = Union[str, None]
|
|
20
|
+
else:
|
|
21
|
+
VERSION_TUPLE = object
|
|
22
|
+
COMMIT_ID = object
|
|
23
|
+
|
|
24
|
+
version: str
|
|
25
|
+
__version__: str
|
|
26
|
+
__version_tuple__: VERSION_TUPLE
|
|
27
|
+
version_tuple: VERSION_TUPLE
|
|
28
|
+
commit_id: COMMIT_ID
|
|
29
|
+
__commit_id__: COMMIT_ID
|
|
30
|
+
|
|
31
|
+
__version__ = version = '0.0.0'
|
|
32
|
+
__version_tuple__ = version_tuple = (0, 0, 0)
|
|
33
|
+
|
|
34
|
+
__commit_id__ = commit_id = None
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# (C) Copyright 2024- ECMWF.
|
|
2
|
+
#
|
|
3
|
+
# This software is licensed under the terms of the Apache Licence Version 2.0
|
|
4
|
+
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
|
|
5
|
+
#
|
|
6
|
+
# In applying this licence, ECMWF does not waive the privileges and immunities
|
|
7
|
+
# granted to it by virtue of its status as an intergovernmental organisation
|
|
8
|
+
# nor does it submit to any jurisdiction.
|
|
9
|
+
|
|
10
|
+
"""
|
|
11
|
+
Declarations related to Artifacts such as ML Model Checkpoints.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
from dataclasses import dataclass
|
|
15
|
+
from typing import Literal
|
|
16
|
+
|
|
17
|
+
from pydantic import BaseModel, Field
|
|
18
|
+
|
|
19
|
+
# NOTE we may eventually fine-grain this with like cuda versions or architecture etc, form a hierarchy, etc. Or maybe not and this will be enough.
|
|
20
|
+
Platform = Literal["macos", "linux"]
|
|
21
|
+
|
|
22
|
+
MlModelCheckpointId = str
|
|
23
|
+
ArtifactStoreId = str
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
@dataclass(frozen=True, eq=True, slots=True)
|
|
27
|
+
class CompositeArtifactId:
|
|
28
|
+
"""Composite identifier for an artifact combining store and checkpoint IDs"""
|
|
29
|
+
|
|
30
|
+
artifact_store_id: ArtifactStoreId
|
|
31
|
+
ml_model_checkpoint_id: MlModelCheckpointId
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class MlModelCheckpoint(BaseModel):
|
|
35
|
+
url: str = Field(
|
|
36
|
+
description="Location such as anemoi catalogue or hugging face registry url. Represents the source url, not an url of a local copy"
|
|
37
|
+
)
|
|
38
|
+
display_name: str = Field(description="Utilized by frontend for listing and picking as input in a job")
|
|
39
|
+
display_author: str = Field(description="Utilized by frontend for displaying author")
|
|
40
|
+
display_description: str = Field(description="Additional info about the model")
|
|
41
|
+
comment: str = Field("", description="Additional internal data at the store level")
|
|
42
|
+
disk_size_bytes: int = Field(description="Physical storage footprint of the checkpoint")
|
|
43
|
+
pip_package_constraints: list[str] = Field(
|
|
44
|
+
description="Pip-compatible constraints for requisite python packages such as torch or anemoi-inference"
|
|
45
|
+
)
|
|
46
|
+
supported_platforms: list[Platform] = Field(
|
|
47
|
+
description="Platforms this model has been tested and verified on"
|
|
48
|
+
) # Question: or negate, ie, 'unsupported'?
|
|
49
|
+
# NOTE this is provisionary -- maybe we'd have a qubed, maybe a qubed<input> template, maybe nothing
|
|
50
|
+
output_characteristics: list[str] = Field(description="List of variables that the model produces")
|
|
51
|
+
input_characteristics: list[str] = Field(
|
|
52
|
+
description="List of config keys that this model exposes"
|
|
53
|
+
) # Question: do we want key-values, or just keys and the plugins define values?
|
|
54
|
+
# Question: how would we capture memory requirements? May be tricky since technically its a function of config and backend
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# (C) Copyright 2024- ECMWF.
|
|
2
|
+
#
|
|
3
|
+
# This software is licensed under the terms of the Apache Licence Version 2.0
|
|
4
|
+
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
|
|
5
|
+
#
|
|
6
|
+
# In applying this licence, ECMWF does not waive the privileges and immunities
|
|
7
|
+
# granted to it by virtue of its status as an intergovernmental organisation
|
|
8
|
+
# nor does it submit to any jurisdiction.
|
|
9
|
+
|
|
10
|
+
"""
|
|
11
|
+
Types pertaining to Forecast As BLock Expression (Fable): blocks
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
from typing import Literal
|
|
15
|
+
|
|
16
|
+
from earthkit.workflows.fluent import Action
|
|
17
|
+
from pydantic import BaseModel, ConfigDict
|
|
18
|
+
from typing_extensions import Self
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class BlockConfigurationOption(BaseModel):
|
|
22
|
+
title: str
|
|
23
|
+
"""Brief string to display in the BlockFactory detail"""
|
|
24
|
+
description: str
|
|
25
|
+
"""Extended description, possibly with example values and their effect"""
|
|
26
|
+
value_type: str
|
|
27
|
+
"""Will be used when deserializing the actual value"""
|
|
28
|
+
# TODO do we want Literal instead of str for values? Do we prefer nesting or flattening for complex config?
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
BlockKind = Literal["source", "transform", "product", "sink"]
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class BlockFactory(BaseModel):
|
|
35
|
+
"""When building a fable, user selects from an available catalogue of BlockFactories which
|
|
36
|
+
have description of what they do and specification of configuration options they offer"""
|
|
37
|
+
|
|
38
|
+
kind: BlockKind
|
|
39
|
+
"""Which role in a job does this block plays"""
|
|
40
|
+
title: str
|
|
41
|
+
"""How to display in the catalogue listing / partial fable"""
|
|
42
|
+
description: str
|
|
43
|
+
"""Extended detail for the user"""
|
|
44
|
+
configuration_options: dict[str, BlockConfigurationOption]
|
|
45
|
+
"""A key-value of config-option-key, config-option"""
|
|
46
|
+
inputs: list[str]
|
|
47
|
+
"""A list of input names, such as 'initial conditions' or 'forecast', for the purpose of description/configuration"""
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
BlockFactoryId = str
|
|
51
|
+
BlockInstanceId = str
|
|
52
|
+
PluginId = str
|
|
53
|
+
PluginStoreId = str
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
class PluginCompositeId(BaseModel):
|
|
57
|
+
model_config = ConfigDict(frozen=True)
|
|
58
|
+
store: PluginStoreId
|
|
59
|
+
local: PluginId
|
|
60
|
+
|
|
61
|
+
@classmethod
|
|
62
|
+
def from_str(cls, v) -> "PluginCompositeId":
|
|
63
|
+
if not ":" in v:
|
|
64
|
+
raise ValueError("must be of the form store:local")
|
|
65
|
+
store, local = v.split(":", 1)
|
|
66
|
+
return cls(store=store, local=local)
|
|
67
|
+
|
|
68
|
+
@staticmethod
|
|
69
|
+
def to_str(k: Self) -> str:
|
|
70
|
+
return f"{k.store}:{k.local}"
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
class PluginBlockFactoryId(BaseModel):
|
|
74
|
+
"""Note to plugin authors: This is a routing class. When you implement your BlockFactories for the catalogue,
|
|
75
|
+
you dont use this, you only need to declare a BlockFactoryId unique inside your plugin. Similarly, when you
|
|
76
|
+
return which BlockFactories are possible in the expand method, you only return your BlockFactoryIds. This
|
|
77
|
+
appears only when you receive BlockInstances in the compile/validate -- and again, you just need to use the
|
|
78
|
+
BlockFactoryId part of this class, as the PluginCompositeId is guaranteed to correspond to your plugin"""
|
|
79
|
+
|
|
80
|
+
plugin: PluginCompositeId
|
|
81
|
+
factory: BlockFactoryId
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
class BlockFactoryCatalogue(BaseModel):
|
|
85
|
+
factories: dict[BlockFactoryId, BlockFactory]
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
class BlockInstance(BaseModel):
|
|
89
|
+
"""As produced by BlockFactory *by the client* -- basically the configuration/inputs values"""
|
|
90
|
+
|
|
91
|
+
factory_id: PluginBlockFactoryId
|
|
92
|
+
configuration_values: dict[str, str]
|
|
93
|
+
"""Keys come frome factory's `configuration_options`, values are serialized actual configuration values"""
|
|
94
|
+
input_ids: dict[str, BlockInstanceId]
|
|
95
|
+
"""Keys come from factory's `inputs`, values are other blocks in the (partial) fable"""
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
class XarrayOutput(BaseModel): # NOTE eventually Qubed
|
|
99
|
+
variables: list[str]
|
|
100
|
+
coords: list[str]
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
BlockInstanceOutput = XarrayOutput # NOTE eventually a Union
|
|
104
|
+
|
|
105
|
+
ActionLookup = dict[BlockInstanceId, Action]
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# (C) Copyright 2024- ECMWF.
|
|
2
|
+
#
|
|
3
|
+
# This software is licensed under the terms of the Apache Licence Version 2.0
|
|
4
|
+
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
|
|
5
|
+
#
|
|
6
|
+
# In applying this licence, ECMWF does not waive the privileges and immunities
|
|
7
|
+
# granted to it by virtue of its status as an intergovernmental organisation
|
|
8
|
+
# nor does it submit to any jurisdiction.
|
|
9
|
+
|
|
10
|
+
"""
|
|
11
|
+
Types pertaining to declaring FIAB Plugins, in particular their Fable-based interface.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
from dataclasses import dataclass
|
|
15
|
+
from typing import Callable
|
|
16
|
+
|
|
17
|
+
from cascade.low.func import Either
|
|
18
|
+
from earthkit.workflows.fluent import Action
|
|
19
|
+
|
|
20
|
+
from fiab_core.fable import (
|
|
21
|
+
ActionLookup,
|
|
22
|
+
BlockFactoryCatalogue,
|
|
23
|
+
BlockFactoryId,
|
|
24
|
+
BlockInstance,
|
|
25
|
+
BlockInstanceId,
|
|
26
|
+
BlockInstanceOutput,
|
|
27
|
+
)
|
|
28
|
+
|
|
29
|
+
Error = str
|
|
30
|
+
Validator = Callable[[BlockInstance, dict[str, BlockInstanceOutput]], Either[BlockInstanceOutput, Error]] # type:ignore[invalid-argument] # semigroup
|
|
31
|
+
"""Given a block instance corresponding to this plugin's Factory and its inputs, either provide error or determine what it outputs"""
|
|
32
|
+
|
|
33
|
+
Expander = Callable[[BlockInstanceOutput], list[BlockFactoryId]]
|
|
34
|
+
"""Given a block instance output (including from other plugin), provide which block factories from this plugin can expand it"""
|
|
35
|
+
|
|
36
|
+
Compiler = Callable[
|
|
37
|
+
[ActionLookup, BlockInstanceId, BlockInstance], Either[Action, Error] # type:ignore[invalid-argument] # semigroup
|
|
38
|
+
]
|
|
39
|
+
"""Given a cascade builder, represented as lookup of fluent actions, and a block instance corresponding to this plugin's Factory, either return the fluent action resulting from this block or an error"""
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
@dataclass
|
|
43
|
+
class Plugin:
|
|
44
|
+
"""Base plugin with a block catalogue and default validate/expand/compile behavior.
|
|
45
|
+
|
|
46
|
+
Override the methods in subclasses when a plugin needs custom logic that does not
|
|
47
|
+
map 1:1 to the BlockFactory implementations.
|
|
48
|
+
"""
|
|
49
|
+
|
|
50
|
+
catalogue: BlockFactoryCatalogue
|
|
51
|
+
validator: Validator
|
|
52
|
+
expander: Expander
|
|
53
|
+
compiler: Compiler
|
|
File without changes
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# (C) Copyright 2024- ECMWF.
|
|
2
|
+
#
|
|
3
|
+
# This software is licensed under the terms of the Apache Licence Version 2.0
|
|
4
|
+
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
|
|
5
|
+
#
|
|
6
|
+
# In applying this licence, ECMWF does not waive the privileges and immunities
|
|
7
|
+
# granted to it by virtue of its status as an intergovernmental organisation
|
|
8
|
+
# nor does it submit to any jurisdiction.
|
|
9
|
+
|
|
10
|
+
import abc
|
|
11
|
+
|
|
12
|
+
from cascade.low.func import Either
|
|
13
|
+
from earthkit.workflows.fluent import Action
|
|
14
|
+
|
|
15
|
+
from fiab_core.fable import (
|
|
16
|
+
ActionLookup,
|
|
17
|
+
BlockConfigurationOption,
|
|
18
|
+
BlockFactory,
|
|
19
|
+
BlockInstance,
|
|
20
|
+
BlockInstanceId,
|
|
21
|
+
BlockInstanceOutput,
|
|
22
|
+
BlockKind,
|
|
23
|
+
)
|
|
24
|
+
from fiab_core.plugin import Error
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class BlockBuilder(abc.ABC):
|
|
28
|
+
kind: BlockKind
|
|
29
|
+
title: str
|
|
30
|
+
description: str
|
|
31
|
+
configuration_options: dict[str, BlockConfigurationOption]
|
|
32
|
+
inputs: list[str]
|
|
33
|
+
|
|
34
|
+
def validate(self, block: BlockInstance, inputs: dict[str, BlockInstanceOutput]) -> Either[BlockInstanceOutput, Error]: # type:ignore[invalid-argument] # semigroup
|
|
35
|
+
raise NotImplementedError
|
|
36
|
+
|
|
37
|
+
def compile(
|
|
38
|
+
self,
|
|
39
|
+
inputs: ActionLookup,
|
|
40
|
+
block_id: BlockInstanceId,
|
|
41
|
+
block: BlockInstance,
|
|
42
|
+
) -> Either[Action, Error]: # type:ignore[invalid-argument] # semigroup
|
|
43
|
+
raise NotImplementedError
|
|
44
|
+
|
|
45
|
+
def intersect(self, input: BlockInstanceOutput) -> bool:
|
|
46
|
+
raise NotImplementedError
|
|
47
|
+
|
|
48
|
+
def as_catalogue(self) -> BlockFactory:
|
|
49
|
+
return BlockFactory(
|
|
50
|
+
kind=self.kind,
|
|
51
|
+
title=self.title,
|
|
52
|
+
description=self.description,
|
|
53
|
+
configuration_options=self.configuration_options,
|
|
54
|
+
inputs=self.inputs,
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
class Source(BlockBuilder):
|
|
59
|
+
kind: BlockKind = "source"
|
|
60
|
+
|
|
61
|
+
def intersect(self, input: BlockInstanceOutput) -> bool:
|
|
62
|
+
return False
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
class Product(BlockBuilder):
|
|
66
|
+
kind: BlockKind = "product"
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
class Sink(BlockBuilder):
|
|
70
|
+
kind: BlockKind = "sink"
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
class Transform(BlockBuilder):
|
|
74
|
+
kind: BlockKind = "transform"
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
from cascade.low.func import Either
|
|
2
|
+
from earthkit.workflows.fluent import Action
|
|
3
|
+
|
|
4
|
+
from fiab_core.fable import (
|
|
5
|
+
ActionLookup,
|
|
6
|
+
BlockFactoryCatalogue,
|
|
7
|
+
BlockFactoryId,
|
|
8
|
+
BlockInstance,
|
|
9
|
+
BlockInstanceId,
|
|
10
|
+
BlockInstanceOutput,
|
|
11
|
+
)
|
|
12
|
+
from fiab_core.plugin import Error, Plugin
|
|
13
|
+
from fiab_core.tools.blocks import BlockBuilder
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class PluginBuilder:
|
|
17
|
+
def __init__(self, block_builders: dict[BlockFactoryId, BlockBuilder]):
|
|
18
|
+
self.block_builders = block_builders
|
|
19
|
+
|
|
20
|
+
def validate(self, block: BlockInstance, inputs: dict[str, BlockInstanceOutput]) -> Either[BlockInstanceOutput, Error]: # type:ignore[invalid-argument] # semigroup
|
|
21
|
+
"""Given a block instance corresponding to this plugin's Factory and its inputs, either provide error or determine what it outputs"""
|
|
22
|
+
factory = self.block_builders[block.factory_id.factory]
|
|
23
|
+
return factory.validate(block, inputs)
|
|
24
|
+
|
|
25
|
+
def expand(self, block: BlockInstanceOutput) -> list[BlockFactoryId]:
|
|
26
|
+
"""Given a block instance output (including from other plugin), provide which block factories from this plugin can expand it"""
|
|
27
|
+
if len(block.variables) == 0:
|
|
28
|
+
return []
|
|
29
|
+
expansions: list[BlockFactoryId] = []
|
|
30
|
+
for factory_id, factory in self.block_builders.items():
|
|
31
|
+
if factory.intersect(block):
|
|
32
|
+
expansions.append(factory_id)
|
|
33
|
+
return expansions
|
|
34
|
+
|
|
35
|
+
def compile(
|
|
36
|
+
self,
|
|
37
|
+
inputs: ActionLookup,
|
|
38
|
+
block_id: BlockInstanceId,
|
|
39
|
+
block: BlockInstance,
|
|
40
|
+
) -> Either[Action, Error]: # type:ignore[invalid-argument] # semigroup
|
|
41
|
+
"""Given a cascade builder and a block instance corresponding to this plugin's Factory, either update the builder with corresponding tasks or provide error"""
|
|
42
|
+
factory = self.block_builders[block.factory_id.factory]
|
|
43
|
+
return factory.compile(inputs, block_id, block)
|
|
44
|
+
|
|
45
|
+
def as_plugin(self) -> Plugin:
|
|
46
|
+
return Plugin(
|
|
47
|
+
catalogue=BlockFactoryCatalogue(
|
|
48
|
+
factories={factory_id: factory.as_catalogue() for factory_id, factory in self.block_builders.items()}
|
|
49
|
+
),
|
|
50
|
+
validator=self.validate,
|
|
51
|
+
expander=self.expand,
|
|
52
|
+
compiler=self.compile,
|
|
53
|
+
)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fiab-core
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: Weather Forecast in a Box, core schemata and definitions
|
|
5
|
+
Author-email: "European Centre for Medium-Range Weather Forecasts (ECMWF)" <software.support@ecmwf.int>
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Requires-Python: >=3.11
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Requires-Dist: pydantic
|
|
11
|
+
Requires-Dist: earthkit-workflows
|
|
12
|
+
Dynamic: license-file
|
|
13
|
+
|
|
14
|
+
Consult the main readme of [forecast-in-a-box](../../README.md), and documentation of [plugins](../../docs/plugins.md).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
.python-version
|
|
2
|
+
LICENSE
|
|
3
|
+
README.md
|
|
4
|
+
justfile
|
|
5
|
+
pyproject.toml
|
|
6
|
+
src/fiab_core/__init__.py
|
|
7
|
+
src/fiab_core/_version.py
|
|
8
|
+
src/fiab_core/artifacts.py
|
|
9
|
+
src/fiab_core/fable.py
|
|
10
|
+
src/fiab_core/plugin.py
|
|
11
|
+
src/fiab_core.egg-info/PKG-INFO
|
|
12
|
+
src/fiab_core.egg-info/SOURCES.txt
|
|
13
|
+
src/fiab_core.egg-info/dependency_links.txt
|
|
14
|
+
src/fiab_core.egg-info/requires.txt
|
|
15
|
+
src/fiab_core.egg-info/top_level.txt
|
|
16
|
+
src/fiab_core/tools/__init__.py
|
|
17
|
+
src/fiab_core/tools/blocks.py
|
|
18
|
+
src/fiab_core/tools/plugins.py
|
|
19
|
+
tests/test_base.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
fiab_core
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# (C) Copyright 2026- ECMWF.
|
|
2
|
+
#
|
|
3
|
+
# This software is licensed under the terms of the Apache Licence Version 2.0
|
|
4
|
+
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
|
|
5
|
+
#
|
|
6
|
+
# In applying this licence, ECMWF does not waive the privileges and immunities
|
|
7
|
+
# granted to it by virtue of its status as an intergovernmental organisation
|
|
8
|
+
# nor does it submit to any jurisdiction.
|
|
9
|
+
|
|
10
|
+
from fiab_core.fable import *
|
|
11
|
+
from fiab_core.plugin import *
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def test_ok():
|
|
15
|
+
"""Tests, as a minimum, that everything can be imported"""
|
|
16
|
+
assert True
|