peteksuite 0.1.2__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.
- peteksuite-0.1.2/.gitignore +47 -0
- peteksuite-0.1.2/LICENSE +201 -0
- peteksuite-0.1.2/NOTICE +8 -0
- peteksuite-0.1.2/PKG-INFO +333 -0
- peteksuite-0.1.2/README.md +112 -0
- peteksuite-0.1.2/pyproject.toml +34 -0
- peteksuite-0.1.2/src/peteksuite/__init__.py +29 -0
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# The coordinator's local working state — never committed (matches each library's convention).
|
|
2
|
+
/dev-docs/
|
|
3
|
+
/inbox/
|
|
4
|
+
/.claude/
|
|
5
|
+
/.mcp.json
|
|
6
|
+
/CLAUDE.local.md
|
|
7
|
+
/.venv/
|
|
8
|
+
/.venv-docs/
|
|
9
|
+
/.uv-cache/
|
|
10
|
+
|
|
11
|
+
# The built docs site (generated by `mkdocs build`) — never committed.
|
|
12
|
+
/site/
|
|
13
|
+
.mkdocs_cache/
|
|
14
|
+
|
|
15
|
+
# The planning graph is local-only (CLAUDE.local.md policy) — never committed.
|
|
16
|
+
/research/
|
|
17
|
+
__pycache__/
|
|
18
|
+
*.pyc
|
|
19
|
+
|
|
20
|
+
# The managed libraries are their own repos — not tracked by the suite root.
|
|
21
|
+
/petekIO/
|
|
22
|
+
/petekStatic/
|
|
23
|
+
/petekSim/
|
|
24
|
+
/petekTools/
|
|
25
|
+
|
|
26
|
+
# macOS
|
|
27
|
+
.DS_Store
|
|
28
|
+
**/.DS_Store
|
|
29
|
+
|
|
30
|
+
# The confidentiality tripwire contains the identifier patterns it hunts — never committed.
|
|
31
|
+
/scrub-check.sh
|
|
32
|
+
|
|
33
|
+
# Local agent/tooling config + helper scripts + study Makefile — never committed.
|
|
34
|
+
/.agents/
|
|
35
|
+
/.codex/
|
|
36
|
+
/gq
|
|
37
|
+
/kg
|
|
38
|
+
/Makefile.local
|
|
39
|
+
|
|
40
|
+
# mkdocs / mkdocs-jupyter build cache — never committed.
|
|
41
|
+
/.cache/
|
|
42
|
+
|
|
43
|
+
# Libraries cloned fresh by the docs build (clone mode / RTD pre_build) — never committed.
|
|
44
|
+
/_libs/
|
|
45
|
+
/.venv-meta/
|
|
46
|
+
/dist/
|
|
47
|
+
/src/peteksuite.egg-info/
|
peteksuite-0.1.2/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 [yyyy] [name of copyright owner]
|
|
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.
|
peteksuite-0.1.2/NOTICE
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
petekSuite — Copyright 2026 Kristian dF Kollsgård
|
|
2
|
+
|
|
3
|
+
This product includes the peteksuite meta-package, licensed under the
|
|
4
|
+
Apache License, Version 2.0. The family packages it installs carry their
|
|
5
|
+
own licenses: petektools and petekio are Apache-2.0; petekstatic and
|
|
6
|
+
peteksim are Business Source License 1.1 (each released version converts
|
|
7
|
+
to Apache-2.0 on its change date). See each package's own LICENSE for the
|
|
8
|
+
authoritative terms.
|
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: peteksuite
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: The petek subsurface-modelling suite — installs the whole family (petektools, petekio, petekstatic, peteksim)
|
|
5
|
+
Project-URL: Documentation, https://peteksuite.readthedocs.io/
|
|
6
|
+
Project-URL: Repository, https://github.com/kkollsga/peteksuite
|
|
7
|
+
Author-email: Kristian dF Kollsgård <kkollsg@gmail.com>
|
|
8
|
+
License: Apache License
|
|
9
|
+
Version 2.0, January 2004
|
|
10
|
+
http://www.apache.org/licenses/
|
|
11
|
+
|
|
12
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
13
|
+
|
|
14
|
+
1. Definitions.
|
|
15
|
+
|
|
16
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
17
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
18
|
+
|
|
19
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
20
|
+
the copyright owner that is granting the License.
|
|
21
|
+
|
|
22
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
23
|
+
other entities that control, are controlled by, or are under common
|
|
24
|
+
control with that entity. For the purposes of this definition,
|
|
25
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
26
|
+
direction or management of such entity, whether by contract or
|
|
27
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
28
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
29
|
+
|
|
30
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
31
|
+
exercising permissions granted by this License.
|
|
32
|
+
|
|
33
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
34
|
+
including but not limited to software source code, documentation
|
|
35
|
+
source, and configuration files.
|
|
36
|
+
|
|
37
|
+
"Object" form shall mean any form resulting from mechanical
|
|
38
|
+
transformation or translation of a Source form, including but
|
|
39
|
+
not limited to compiled object code, generated documentation,
|
|
40
|
+
and conversions to other media types.
|
|
41
|
+
|
|
42
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
43
|
+
Object form, made available under the License, as indicated by a
|
|
44
|
+
copyright notice that is included in or attached to the work
|
|
45
|
+
(an example is provided in the Appendix below).
|
|
46
|
+
|
|
47
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
48
|
+
form, that is based on (or derived from) the Work and for which the
|
|
49
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
50
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
51
|
+
of this License, Derivative Works shall not include works that remain
|
|
52
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
53
|
+
the Work and Derivative Works thereof.
|
|
54
|
+
|
|
55
|
+
"Contribution" shall mean any work of authorship, including
|
|
56
|
+
the original version of the Work and any modifications or additions
|
|
57
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
58
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
59
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
60
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
61
|
+
means any form of electronic, verbal, or written communication sent
|
|
62
|
+
to the Licensor or its representatives, including but not limited to
|
|
63
|
+
communication on electronic mailing lists, source code control systems,
|
|
64
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
65
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
66
|
+
excluding communication that is conspicuously marked or otherwise
|
|
67
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
68
|
+
|
|
69
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
70
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
71
|
+
subsequently incorporated within the Work.
|
|
72
|
+
|
|
73
|
+
2. Grant of Copyright 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
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
77
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
78
|
+
Work and such Derivative Works in Source or Object form.
|
|
79
|
+
|
|
80
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
81
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
82
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
83
|
+
(except as stated in this section) patent license to make, have made,
|
|
84
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
85
|
+
where such license applies only to those patent claims licensable
|
|
86
|
+
by such Contributor that are necessarily infringed by their
|
|
87
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
88
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
89
|
+
institute patent litigation against any entity (including a
|
|
90
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
91
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
92
|
+
or contributory patent infringement, then any patent licenses
|
|
93
|
+
granted to You under this License for that Work shall terminate
|
|
94
|
+
as of the date such litigation is filed.
|
|
95
|
+
|
|
96
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
97
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
98
|
+
modifications, and in Source or Object form, provided that You
|
|
99
|
+
meet the following conditions:
|
|
100
|
+
|
|
101
|
+
(a) You must give any other recipients of the Work or
|
|
102
|
+
Derivative Works a copy of this License; and
|
|
103
|
+
|
|
104
|
+
(b) You must cause any modified files to carry prominent notices
|
|
105
|
+
stating that You changed the files; and
|
|
106
|
+
|
|
107
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
108
|
+
that You distribute, all copyright, patent, trademark, and
|
|
109
|
+
attribution notices from the Source form of the Work,
|
|
110
|
+
excluding those notices that do not pertain to any part of
|
|
111
|
+
the Derivative Works; and
|
|
112
|
+
|
|
113
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
114
|
+
distribution, then any Derivative Works that You distribute must
|
|
115
|
+
include a readable copy of the attribution notices contained
|
|
116
|
+
within such NOTICE file, excluding those notices that do not
|
|
117
|
+
pertain to any part of the Derivative Works, in at least one
|
|
118
|
+
of the following places: within a NOTICE text file distributed
|
|
119
|
+
as part of the Derivative Works; within the Source form or
|
|
120
|
+
documentation, if provided along with the Derivative Works; or,
|
|
121
|
+
within a display generated by the Derivative Works, if and
|
|
122
|
+
wherever such third-party notices normally appear. The contents
|
|
123
|
+
of the NOTICE file are for informational purposes only and
|
|
124
|
+
do not modify the License. You may add Your own attribution
|
|
125
|
+
notices within Derivative Works that You distribute, alongside
|
|
126
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
127
|
+
that such additional attribution notices cannot be construed
|
|
128
|
+
as modifying the License.
|
|
129
|
+
|
|
130
|
+
You may add Your own copyright statement to Your modifications and
|
|
131
|
+
may provide additional or different license terms and conditions
|
|
132
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
133
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
134
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
135
|
+
the conditions stated in this License.
|
|
136
|
+
|
|
137
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
138
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
139
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
140
|
+
this License, without any additional terms or conditions.
|
|
141
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
142
|
+
the terms of any separate license agreement you may have executed
|
|
143
|
+
with Licensor regarding such Contributions.
|
|
144
|
+
|
|
145
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
146
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
147
|
+
except as required for reasonable and customary use in describing the
|
|
148
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
149
|
+
|
|
150
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
151
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
152
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
153
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
154
|
+
implied, including, without limitation, any warranties or conditions
|
|
155
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
156
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
157
|
+
appropriateness of using or redistributing the Work and assume any
|
|
158
|
+
risks associated with Your exercise of permissions under this License.
|
|
159
|
+
|
|
160
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
161
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
162
|
+
unless required by applicable law (such as deliberate and grossly
|
|
163
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
164
|
+
liable to You for damages, including any direct, indirect, special,
|
|
165
|
+
incidental, or consequential damages of any character arising as a
|
|
166
|
+
result of this License or out of the use or inability to use the
|
|
167
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
168
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
169
|
+
other commercial damages or losses), even if such Contributor
|
|
170
|
+
has been advised of the possibility of such damages.
|
|
171
|
+
|
|
172
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
173
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
174
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
175
|
+
or other liability obligations and/or rights consistent with this
|
|
176
|
+
License. However, in accepting such obligations, You may act only
|
|
177
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
178
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
179
|
+
defend, and hold each Contributor harmless for any liability
|
|
180
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
181
|
+
of your accepting any such warranty or additional liability.
|
|
182
|
+
|
|
183
|
+
END OF TERMS AND CONDITIONS
|
|
184
|
+
|
|
185
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
186
|
+
|
|
187
|
+
To apply the Apache License to your work, attach the following
|
|
188
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
189
|
+
replaced with your own identifying information. (Don't include
|
|
190
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
191
|
+
comment syntax for the file format. We also recommend that a
|
|
192
|
+
file or class name and description of purpose be included on the
|
|
193
|
+
same "printed page" as the copyright notice for easier
|
|
194
|
+
identification within third-party archives.
|
|
195
|
+
|
|
196
|
+
Copyright [yyyy] [name of copyright owner]
|
|
197
|
+
|
|
198
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
199
|
+
you may not use this file except in compliance with the License.
|
|
200
|
+
You may obtain a copy of the License at
|
|
201
|
+
|
|
202
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
203
|
+
|
|
204
|
+
Unless required by applicable law or agreed to in writing, software
|
|
205
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
206
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
207
|
+
See the License for the specific language governing permissions and
|
|
208
|
+
limitations under the License.
|
|
209
|
+
License-File: LICENSE
|
|
210
|
+
License-File: NOTICE
|
|
211
|
+
Keywords: geomodel,petrophysics,reservoir,subsurface,volumetrics
|
|
212
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
213
|
+
Classifier: Programming Language :: Python :: 3
|
|
214
|
+
Classifier: Topic :: Scientific/Engineering
|
|
215
|
+
Requires-Python: >=3.10
|
|
216
|
+
Requires-Dist: petekio>=0.3.2
|
|
217
|
+
Requires-Dist: peteksim>=0.1.3
|
|
218
|
+
Requires-Dist: petekstatic>=0.1.5
|
|
219
|
+
Requires-Dist: petektools>=0.2.3
|
|
220
|
+
Description-Content-Type: text/markdown
|
|
221
|
+
|
|
222
|
+
# petekSuite
|
|
223
|
+
|
|
224
|
+
**petekSuite** is the umbrella for a subsurface-modelling ecosystem: a small
|
|
225
|
+
family of Rust libraries (with Python bindings) that take raw subsurface data all
|
|
226
|
+
the way to static volumes and dynamic forecasts. The suite root itself builds no
|
|
227
|
+
code — it coordinates the peer libraries, keeps their seams coherent, and holds
|
|
228
|
+
the shared conventions ("the petek house style") that make them a family rather
|
|
229
|
+
than a monolith.
|
|
230
|
+
|
|
231
|
+
Dependencies flow **one direction, downward only** — no cycles, no sideways
|
|
232
|
+
sharing of code. Libraries share *conventions* freely and share *code* only
|
|
233
|
+
downward through the graph; each library stays usable standalone.
|
|
234
|
+
|
|
235
|
+
```
|
|
236
|
+
┌─────────────────────────────────────────┐
|
|
237
|
+
petekIO DATA │ ingest · normalize · validate · │
|
|
238
|
+
│ │ interpret → model-ready inputs │
|
|
239
|
+
▼ └─────────────────────────────────────────┘
|
|
240
|
+
petekStatic GEOMODEL structural framework · grid · property
|
|
241
|
+
│ modelling · volumetrics + static uncertainty
|
|
242
|
+
▼
|
|
243
|
+
petekSim SIMULATION dynamic / engineering forecast · PVT ·
|
|
244
|
+
the `peteksim` Python product facade
|
|
245
|
+
|
|
246
|
+
petekTools TOOLKIT horizontal · shared · domain-agnostic:
|
|
247
|
+
numeric kernels + units + container + viewer
|
|
248
|
+
(serves every layer)
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
## The libraries
|
|
252
|
+
|
|
253
|
+
### petekIO — the DATA layer
|
|
254
|
+
Ingests, normalizes, validates, and interprets subsurface data (wells, surfaces,
|
|
255
|
+
logs, seismic) into clean, **model-ready inputs**. A standalone Rust data-model +
|
|
256
|
+
IO library with optional PyO3 bindings — data only, no modelling framework.
|
|
257
|
+
Composes mature crates (`las_rs`, `geo`/`geozero`, `ndarray`, `rstar`,
|
|
258
|
+
`giga-segy`) behind its own IO traits.
|
|
259
|
+
|
|
260
|
+
### petekStatic — the GEOMODEL layer
|
|
261
|
+
Turns model-ready inputs into a populated **StaticModel**: the structural
|
|
262
|
+
framework (horizons + faults + zones), grid construction, and property modelling
|
|
263
|
+
(facies/petrophysics, geostatistics, trend population, log upscaling). It owns
|
|
264
|
+
**volumetrics + static uncertainty** — GRV / in-place volumes off the model
|
|
265
|
+
itself, Monte-Carlo over model realizations, and tornado analysis — producing a
|
|
266
|
+
StaticModel plus probabilistic (P90/P50/P10) curves.
|
|
267
|
+
|
|
268
|
+
### petekSim — the SIMULATION layer
|
|
269
|
+
Dynamic and engineering simulation: recoverable volumes and forecasting (decline,
|
|
270
|
+
p/z, material balance, and later full dynamic flow), plus PVT. It ships **the
|
|
271
|
+
product** — `peteksim`, the Python-facing appraisal toolkit that presents the
|
|
272
|
+
whole stack behind one façade.
|
|
273
|
+
|
|
274
|
+
### petekTools — the horizontal TOOLKIT
|
|
275
|
+
Domain-agnostic, shared numerics that serve every layer: the scattered-data
|
|
276
|
+
gridding / kriging / warm-start / geostatistics kernels Rust lacks, a units
|
|
277
|
+
system, the liftable container format, and a generic bundle viewer. A pure leaf —
|
|
278
|
+
it depends on none of the others; they build on it.
|
|
279
|
+
|
|
280
|
+
## Install
|
|
281
|
+
|
|
282
|
+
The whole suite installs with one command:
|
|
283
|
+
|
|
284
|
+
```sh
|
|
285
|
+
pip install peteksuite # the meta-package: pulls all four libraries
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
Every library is also **directly installable** from both crates.io (Rust) and
|
|
289
|
+
PyPI (Python) — one crate and one wheel per library:
|
|
290
|
+
|
|
291
|
+
| Library | version | pip | Status |
|
|
292
|
+
|--------------|---------|----------------------------|---------------------|
|
|
293
|
+
| petekTools | 0.2.3 | `pip install petektools` | live |
|
|
294
|
+
| petekIO | 0.3.2 | `pip install petekio` | live |
|
|
295
|
+
| petekStatic | 0.1.5 | `pip install petekstatic` | live |
|
|
296
|
+
| petekSim | 0.1.3 | `pip install peteksim` | live |
|
|
297
|
+
|
|
298
|
+
### Rust (crates.io)
|
|
299
|
+
|
|
300
|
+
```sh
|
|
301
|
+
cargo add petektools@0.2.3 # TOOLKIT — numeric kernels, units, container
|
|
302
|
+
cargo add petekio@0.3.2 # DATA — ingest + model-ready inputs
|
|
303
|
+
cargo add petekstatic@0.1.5 # GEOMODEL — StaticModel build + volumetrics + MC
|
|
304
|
+
cargo add peteksim@0.1.3 # SIMULATION — the appraisal facade over the stack
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
### Python (PyPI)
|
|
308
|
+
|
|
309
|
+
```sh
|
|
310
|
+
pip install petektools==0.2.3
|
|
311
|
+
pip install petekio==0.3.2
|
|
312
|
+
pip install petekstatic==0.1.5 # static workflow API, StaticModel, volumes + bundles
|
|
313
|
+
pip install peteksim==0.1.3 # the full appraisal facade over the whole stack
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
Dependencies resolve automatically in DAG order (peteksim pulls the stack;
|
|
317
|
+
petekstatic pulls petekio + petektools).
|
|
318
|
+
|
|
319
|
+
## License
|
|
320
|
+
|
|
321
|
+
The suite is split by layer:
|
|
322
|
+
|
|
323
|
+
| Library | License |
|
|
324
|
+
|--------------|------------------------------------------------------|
|
|
325
|
+
| petekTools | Apache-2.0 |
|
|
326
|
+
| petekIO | Apache-2.0 |
|
|
327
|
+
| petekStatic | Business Source License 1.1 (converts to Apache-2.0) |
|
|
328
|
+
| petekSim | Business Source License 1.1 (converts to Apache-2.0) |
|
|
329
|
+
|
|
330
|
+
The horizontal toolkit and the data layer are permissively licensed (Apache-2.0).
|
|
331
|
+
The geomodel and simulation layers ship under the Business Source License 1.1,
|
|
332
|
+
each released version converting to Apache-2.0 on its change date. See each
|
|
333
|
+
library's own `LICENSE` / `NOTICE` for the authoritative terms.
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
# petekSuite
|
|
2
|
+
|
|
3
|
+
**petekSuite** is the umbrella for a subsurface-modelling ecosystem: a small
|
|
4
|
+
family of Rust libraries (with Python bindings) that take raw subsurface data all
|
|
5
|
+
the way to static volumes and dynamic forecasts. The suite root itself builds no
|
|
6
|
+
code — it coordinates the peer libraries, keeps their seams coherent, and holds
|
|
7
|
+
the shared conventions ("the petek house style") that make them a family rather
|
|
8
|
+
than a monolith.
|
|
9
|
+
|
|
10
|
+
Dependencies flow **one direction, downward only** — no cycles, no sideways
|
|
11
|
+
sharing of code. Libraries share *conventions* freely and share *code* only
|
|
12
|
+
downward through the graph; each library stays usable standalone.
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
┌─────────────────────────────────────────┐
|
|
16
|
+
petekIO DATA │ ingest · normalize · validate · │
|
|
17
|
+
│ │ interpret → model-ready inputs │
|
|
18
|
+
▼ └─────────────────────────────────────────┘
|
|
19
|
+
petekStatic GEOMODEL structural framework · grid · property
|
|
20
|
+
│ modelling · volumetrics + static uncertainty
|
|
21
|
+
▼
|
|
22
|
+
petekSim SIMULATION dynamic / engineering forecast · PVT ·
|
|
23
|
+
the `peteksim` Python product facade
|
|
24
|
+
|
|
25
|
+
petekTools TOOLKIT horizontal · shared · domain-agnostic:
|
|
26
|
+
numeric kernels + units + container + viewer
|
|
27
|
+
(serves every layer)
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## The libraries
|
|
31
|
+
|
|
32
|
+
### petekIO — the DATA layer
|
|
33
|
+
Ingests, normalizes, validates, and interprets subsurface data (wells, surfaces,
|
|
34
|
+
logs, seismic) into clean, **model-ready inputs**. A standalone Rust data-model +
|
|
35
|
+
IO library with optional PyO3 bindings — data only, no modelling framework.
|
|
36
|
+
Composes mature crates (`las_rs`, `geo`/`geozero`, `ndarray`, `rstar`,
|
|
37
|
+
`giga-segy`) behind its own IO traits.
|
|
38
|
+
|
|
39
|
+
### petekStatic — the GEOMODEL layer
|
|
40
|
+
Turns model-ready inputs into a populated **StaticModel**: the structural
|
|
41
|
+
framework (horizons + faults + zones), grid construction, and property modelling
|
|
42
|
+
(facies/petrophysics, geostatistics, trend population, log upscaling). It owns
|
|
43
|
+
**volumetrics + static uncertainty** — GRV / in-place volumes off the model
|
|
44
|
+
itself, Monte-Carlo over model realizations, and tornado analysis — producing a
|
|
45
|
+
StaticModel plus probabilistic (P90/P50/P10) curves.
|
|
46
|
+
|
|
47
|
+
### petekSim — the SIMULATION layer
|
|
48
|
+
Dynamic and engineering simulation: recoverable volumes and forecasting (decline,
|
|
49
|
+
p/z, material balance, and later full dynamic flow), plus PVT. It ships **the
|
|
50
|
+
product** — `peteksim`, the Python-facing appraisal toolkit that presents the
|
|
51
|
+
whole stack behind one façade.
|
|
52
|
+
|
|
53
|
+
### petekTools — the horizontal TOOLKIT
|
|
54
|
+
Domain-agnostic, shared numerics that serve every layer: the scattered-data
|
|
55
|
+
gridding / kriging / warm-start / geostatistics kernels Rust lacks, a units
|
|
56
|
+
system, the liftable container format, and a generic bundle viewer. A pure leaf —
|
|
57
|
+
it depends on none of the others; they build on it.
|
|
58
|
+
|
|
59
|
+
## Install
|
|
60
|
+
|
|
61
|
+
The whole suite installs with one command:
|
|
62
|
+
|
|
63
|
+
```sh
|
|
64
|
+
pip install peteksuite # the meta-package: pulls all four libraries
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Every library is also **directly installable** from both crates.io (Rust) and
|
|
68
|
+
PyPI (Python) — one crate and one wheel per library:
|
|
69
|
+
|
|
70
|
+
| Library | version | pip | Status |
|
|
71
|
+
|--------------|---------|----------------------------|---------------------|
|
|
72
|
+
| petekTools | 0.2.3 | `pip install petektools` | live |
|
|
73
|
+
| petekIO | 0.3.2 | `pip install petekio` | live |
|
|
74
|
+
| petekStatic | 0.1.5 | `pip install petekstatic` | live |
|
|
75
|
+
| petekSim | 0.1.3 | `pip install peteksim` | live |
|
|
76
|
+
|
|
77
|
+
### Rust (crates.io)
|
|
78
|
+
|
|
79
|
+
```sh
|
|
80
|
+
cargo add petektools@0.2.3 # TOOLKIT — numeric kernels, units, container
|
|
81
|
+
cargo add petekio@0.3.2 # DATA — ingest + model-ready inputs
|
|
82
|
+
cargo add petekstatic@0.1.5 # GEOMODEL — StaticModel build + volumetrics + MC
|
|
83
|
+
cargo add peteksim@0.1.3 # SIMULATION — the appraisal facade over the stack
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Python (PyPI)
|
|
87
|
+
|
|
88
|
+
```sh
|
|
89
|
+
pip install petektools==0.2.3
|
|
90
|
+
pip install petekio==0.3.2
|
|
91
|
+
pip install petekstatic==0.1.5 # static workflow API, StaticModel, volumes + bundles
|
|
92
|
+
pip install peteksim==0.1.3 # the full appraisal facade over the whole stack
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Dependencies resolve automatically in DAG order (peteksim pulls the stack;
|
|
96
|
+
petekstatic pulls petekio + petektools).
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
The suite is split by layer:
|
|
101
|
+
|
|
102
|
+
| Library | License |
|
|
103
|
+
|--------------|------------------------------------------------------|
|
|
104
|
+
| petekTools | Apache-2.0 |
|
|
105
|
+
| petekIO | Apache-2.0 |
|
|
106
|
+
| petekStatic | Business Source License 1.1 (converts to Apache-2.0) |
|
|
107
|
+
| petekSim | Business Source License 1.1 (converts to Apache-2.0) |
|
|
108
|
+
|
|
109
|
+
The horizontal toolkit and the data layer are permissively licensed (Apache-2.0).
|
|
110
|
+
The geomodel and simulation layers ship under the Business Source License 1.1,
|
|
111
|
+
each released version converting to Apache-2.0 on its change date. See each
|
|
112
|
+
library's own `LICENSE` / `NOTICE` for the authoritative terms.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "peteksuite"
|
|
7
|
+
version = "0.1.2"
|
|
8
|
+
description = "The petek subsurface-modelling suite — installs the whole family (petektools, petekio, petekstatic, peteksim)"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = { file = "LICENSE" }
|
|
12
|
+
authors = [{ name = "Kristian dF Kollsgård", email = "kkollsg@gmail.com" }]
|
|
13
|
+
keywords = ["reservoir", "geomodel", "volumetrics", "subsurface", "petrophysics"]
|
|
14
|
+
classifiers = [
|
|
15
|
+
"Programming Language :: Python :: 3",
|
|
16
|
+
"License :: OSI Approved :: Apache Software License",
|
|
17
|
+
"Topic :: Scientific/Engineering",
|
|
18
|
+
]
|
|
19
|
+
dependencies = [
|
|
20
|
+
"petektools>=0.2.3",
|
|
21
|
+
"petekio>=0.3.2",
|
|
22
|
+
"petekstatic>=0.1.5",
|
|
23
|
+
"peteksim>=0.1.3",
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
[project.urls]
|
|
27
|
+
Documentation = "https://peteksuite.readthedocs.io/"
|
|
28
|
+
Repository = "https://github.com/kkollsga/peteksuite"
|
|
29
|
+
|
|
30
|
+
[tool.hatch.build.targets.wheel]
|
|
31
|
+
packages = ["src/peteksuite"]
|
|
32
|
+
|
|
33
|
+
[tool.hatch.build.targets.sdist]
|
|
34
|
+
include = ["src/peteksuite", "README.md", "LICENSE", "NOTICE"]
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"""petekSuite — the umbrella meta-package for the petek subsurface-modelling family.
|
|
2
|
+
|
|
3
|
+
Installing ``peteksuite`` pulls the whole stack:
|
|
4
|
+
|
|
5
|
+
- ``petekio`` — the DATA layer (ingest, normalize, validate → model-ready inputs)
|
|
6
|
+
- ``petekstatic`` — the GEOMODEL layer (framework, grid, properties, volumetrics, MC)
|
|
7
|
+
- ``peteksim`` — the SIMULATION layer and the appraisal facade (start here)
|
|
8
|
+
- ``petektools`` — the horizontal toolkit (kernels, units, viewer)
|
|
9
|
+
|
|
10
|
+
The product entry point is ``import peteksim as ps`` — see
|
|
11
|
+
https://peteksuite.readthedocs.io/ for the tutorials and the full reference.
|
|
12
|
+
"""
|
|
13
|
+
|
|
14
|
+
from importlib.metadata import PackageNotFoundError, version as _version
|
|
15
|
+
|
|
16
|
+
__version__ = "0.1.2"
|
|
17
|
+
|
|
18
|
+
_FAMILY = ("petektools", "petekio", "petekstatic", "peteksim")
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
def versions() -> dict[str, str]:
|
|
22
|
+
"""Installed versions of every family package (plus this meta-package)."""
|
|
23
|
+
out = {"peteksuite": __version__}
|
|
24
|
+
for name in _FAMILY:
|
|
25
|
+
try:
|
|
26
|
+
out[name] = _version(name)
|
|
27
|
+
except PackageNotFoundError: # pragma: no cover — deps guarantee presence
|
|
28
|
+
out[name] = "not installed"
|
|
29
|
+
return out
|