PicoMats 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.
- picomats-0.0.0/.gitignore +3 -0
- picomats-0.0.0/LICENSE +21 -0
- picomats-0.0.0/PKG-INFO +178 -0
- picomats-0.0.0/README.md +137 -0
- picomats-0.0.0/pyproject.toml +45 -0
- picomats-0.0.0/src/ontology/__init__.py +2 -0
- picomats-0.0.0/src/ontology/abstract/_placeholder +0 -0
- picomats-0.0.0/src/ontology/fundamental/_placeholder +0 -0
- picomats-0.0.0/src/ontology/metric.ut +34 -0
picomats-0.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 William Bowley
|
|
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.
|
picomats-0.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: PicoMats
|
|
3
|
+
Version: 0.0.0
|
|
4
|
+
Summary: A unit-informed, assumption-driven material ontology.
|
|
5
|
+
Project-URL: Homepage, https://github.com/Bowley-Systems/PicoMats
|
|
6
|
+
Project-URL: Bug Tracker, https://github.com/Bowley-Systems/PicoMats/issues
|
|
7
|
+
Author-email: William Bowley <wgrantbowley@gmail.com>
|
|
8
|
+
Maintainer-email: William Bowley <wgrantbowley@gmail.com>
|
|
9
|
+
License: MIT License
|
|
10
|
+
|
|
11
|
+
Copyright (c) 2026 William Bowley
|
|
12
|
+
|
|
13
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
14
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
15
|
+
in the Software without restriction, including without limitation the rights
|
|
16
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
17
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
18
|
+
furnished to do so, subject to the following conditions:
|
|
19
|
+
|
|
20
|
+
The above copyright notice and this permission notice shall be included in all
|
|
21
|
+
copies or substantial portions of the Software.
|
|
22
|
+
|
|
23
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
24
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
25
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
26
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
27
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
28
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
29
|
+
SOFTWARE.
|
|
30
|
+
License-File: LICENSE
|
|
31
|
+
Keywords: assumptions,materials,physics,units
|
|
32
|
+
Classifier: Intended Audience :: Developers
|
|
33
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
34
|
+
Classifier: Operating System :: OS Independent
|
|
35
|
+
Classifier: Programming Language :: Python :: 3
|
|
36
|
+
Classifier: Topic :: Scientific/Engineering
|
|
37
|
+
Requires-Python: >=3.10
|
|
38
|
+
Requires-Dist: numpy
|
|
39
|
+
Requires-Dist: picounits
|
|
40
|
+
Description-Content-Type: text/markdown
|
|
41
|
+
|
|
42
|
+
<!--
|
|
43
|
+
Color palette:
|
|
44
|
+
#006d77ff -> deep, muted teal-green
|
|
45
|
+
#d92c2aff -> bold, warm crimson-red
|
|
46
|
+
|
|
47
|
+
It might seem risky to define a new ontology for materials,
|
|
48
|
+
but imagine for a second you're trying to do work across
|
|
49
|
+
electromagnetic, mechanical, and chemical systems.
|
|
50
|
+
|
|
51
|
+
And imagine your goal is to have a material backend that
|
|
52
|
+
has the same routing from v0.1 to vn.n. It needs to be
|
|
53
|
+
made general-purpose.
|
|
54
|
+
|
|
55
|
+
— William Bowley, 12th of August, 2026
|
|
56
|
+
-->
|
|
57
|
+
|
|
58
|
+
<!-- Update this image before its on pypi -->
|
|
59
|
+
|
|
60
|
+
<p align="center"><img src="https://raw.githubusercontent.com/Bowley-Systems/PicoMats/refs/heads/main/media/logo.png" alt="PicoMats logo" style="width:100%; max-width:100%; display:block;"></p>
|
|
61
|
+
<h4 align="center">A unit-informed, assumption-driven material ontology.</h4>
|
|
62
|
+
<p align="center">
|
|
63
|
+
Use the material. Sustain the assumptions. <br>
|
|
64
|
+
Reduce uncertainty by making every assumption explicit.
|
|
65
|
+
</p>
|
|
66
|
+
|
|
67
|
+
# Overview
|
|
68
|
+
|
|
69
|
+

|
|
70
|
+

|
|
71
|
+
|
|
72
|
+
PicoMats is an assumption-driven material ontology that sustains assumptions throughout your pipeline. It provides unit-informed material definitions with accompanying assumptions.
|
|
73
|
+
|
|
74
|
+
> [!important]
|
|
75
|
+
>
|
|
76
|
+
> ### Features:
|
|
77
|
+
> - Follows a computational ontology called `Abstract-Fundamental Ontology`.
|
|
78
|
+
> - Uses `UnitValues` and `PicoUnits` for encoding typed numerical definitions.
|
|
79
|
+
> - Tracks assumptions alongside material definitions to reduce model uncertainty.
|
|
80
|
+
|
|
81
|
+
## What is the Abstract-Fundamental Ontology?
|
|
82
|
+
|
|
83
|
+
Abstract-Fundamental Ontology is a computational abstraction for both reductionist and pragmatist applications.
|
|
84
|
+
|
|
85
|
+
The model is based on two categories:
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
Abstract: Defined by what it does (measured properties).
|
|
89
|
+
Fundamental: Defined by what it is (atomic structure).
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
The ontology emerges from this simple thought experiment:
|
|
95
|
+
|
|
96
|
+
```
|
|
97
|
+
Let's model a ball rolling down a ramp.
|
|
98
|
+
↓
|
|
99
|
+
What forces act on the ball?
|
|
100
|
+
↓
|
|
101
|
+
Gravity, electromagnetic repulsion, and friction.
|
|
102
|
+
↓
|
|
103
|
+
How do we model friction?
|
|
104
|
+
↓
|
|
105
|
+
A coefficient? Isn't that arbitrary?
|
|
106
|
+
↓
|
|
107
|
+
Why not just model it?
|
|
108
|
+
↓
|
|
109
|
+
What exactly is friction?
|
|
110
|
+
↓
|
|
111
|
+
Oh, random microscopic interactions...
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
It's a mistake to assume it's impossible to model, but computational cost is prohibitive for most applications. Hence, you `abstract` it via empirical methods to measure friction, losing all but the necessary information.
|
|
115
|
+
|
|
116
|
+
But `abstract` isn't always the right model...
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
I want to research superconductors.
|
|
120
|
+
↓
|
|
121
|
+
Oh, my temperature range is 0 K to 200 K.
|
|
122
|
+
↓
|
|
123
|
+
Where do I get material definitions for that range?
|
|
124
|
+
↓
|
|
125
|
+
I'll just interpolate the standard Niobium definition.
|
|
126
|
+
↓
|
|
127
|
+
Actually, how were these measurements obtained?
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
When asking such a fundamental question, wouldn't it be best to derive the relations from what the material fundamentally is? Hence, you use `fundamental`, which describes what the material is, and build the necessary properties without measurement-implicit assumptions.
|
|
131
|
+
|
|
132
|
+
> [!IMPORTANT]
|
|
133
|
+
>
|
|
134
|
+
> PicoMats does not calculate material properties from the fundamental characteristics of the elements. It is up to the user to compute them via custom modelling or external frameworks.
|
|
135
|
+
|
|
136
|
+
---
|
|
137
|
+
|
|
138
|
+
> [!NOTE]
|
|
139
|
+
>
|
|
140
|
+
> Both `abstract` and `fundamental` also make a good semantic boundary for model development. For example, `material.abstract.copper` and `material.fundamental.copper` explicitly denote the reality of their origin.
|
|
141
|
+
|
|
142
|
+
## Proposed workflow
|
|
143
|
+
|
|
144
|
+
PicoMats is still under development for `v0.1-alpha`. Implementation details and some abstractions may change.
|
|
145
|
+
|
|
146
|
+
```py
|
|
147
|
+
from picomats import mm
|
|
148
|
+
from picomats import Materials
|
|
149
|
+
|
|
150
|
+
# Pulls materials into the simulation
|
|
151
|
+
copper = Materials.abstract.pure.copper
|
|
152
|
+
|
|
153
|
+
density = copper.density
|
|
154
|
+
volume = 100 * mm ** 3
|
|
155
|
+
|
|
156
|
+
mass = volume * density
|
|
157
|
+
# > Output: 0.896 m(kg)
|
|
158
|
+
|
|
159
|
+
copper.assumptions.density
|
|
160
|
+
# > Output:
|
|
161
|
+
# >└── Method
|
|
162
|
+
# > ├── Hydrostatic Balance (Archimedes' Principle)
|
|
163
|
+
# > └── Media Type: Distilled Water
|
|
164
|
+
# >└── Assumptions
|
|
165
|
+
# > ├── Lack of air bubbles within media
|
|
166
|
+
# > └── Media temperature stability
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Installation
|
|
170
|
+
|
|
171
|
+
Until release, this only installs the overview page and related files:
|
|
172
|
+
```bash
|
|
173
|
+
pip install PicoMats
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Documentation
|
|
177
|
+
|
|
178
|
+
All internal documentation can be found within this repo's [issues](https://github.com/wgbowley/PicoMaterials/issues).
|
picomats-0.0.0/README.md
ADDED
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
Color palette:
|
|
3
|
+
#006d77ff -> deep, muted teal-green
|
|
4
|
+
#d92c2aff -> bold, warm crimson-red
|
|
5
|
+
|
|
6
|
+
It might seem risky to define a new ontology for materials,
|
|
7
|
+
but imagine for a second you're trying to do work across
|
|
8
|
+
electromagnetic, mechanical, and chemical systems.
|
|
9
|
+
|
|
10
|
+
And imagine your goal is to have a material backend that
|
|
11
|
+
has the same routing from v0.1 to vn.n. It needs to be
|
|
12
|
+
made general-purpose.
|
|
13
|
+
|
|
14
|
+
— William Bowley, 12th of August, 2026
|
|
15
|
+
-->
|
|
16
|
+
|
|
17
|
+
<!-- Update this image before its on pypi -->
|
|
18
|
+
|
|
19
|
+
<p align="center"><img src="https://raw.githubusercontent.com/Bowley-Systems/PicoMats/refs/heads/main/media/logo.png" alt="PicoMats logo" style="width:100%; max-width:100%; display:block;"></p>
|
|
20
|
+
<h4 align="center">A unit-informed, assumption-driven material ontology.</h4>
|
|
21
|
+
<p align="center">
|
|
22
|
+
Use the material. Sustain the assumptions. <br>
|
|
23
|
+
Reduce uncertainty by making every assumption explicit.
|
|
24
|
+
</p>
|
|
25
|
+
|
|
26
|
+
# Overview
|
|
27
|
+
|
|
28
|
+

|
|
29
|
+

|
|
30
|
+
|
|
31
|
+
PicoMats is an assumption-driven material ontology that sustains assumptions throughout your pipeline. It provides unit-informed material definitions with accompanying assumptions.
|
|
32
|
+
|
|
33
|
+
> [!important]
|
|
34
|
+
>
|
|
35
|
+
> ### Features:
|
|
36
|
+
> - Follows a computational ontology called `Abstract-Fundamental Ontology`.
|
|
37
|
+
> - Uses `UnitValues` and `PicoUnits` for encoding typed numerical definitions.
|
|
38
|
+
> - Tracks assumptions alongside material definitions to reduce model uncertainty.
|
|
39
|
+
|
|
40
|
+
## What is the Abstract-Fundamental Ontology?
|
|
41
|
+
|
|
42
|
+
Abstract-Fundamental Ontology is a computational abstraction for both reductionist and pragmatist applications.
|
|
43
|
+
|
|
44
|
+
The model is based on two categories:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
Abstract: Defined by what it does (measured properties).
|
|
48
|
+
Fundamental: Defined by what it is (atomic structure).
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
The ontology emerges from this simple thought experiment:
|
|
54
|
+
|
|
55
|
+
```
|
|
56
|
+
Let's model a ball rolling down a ramp.
|
|
57
|
+
↓
|
|
58
|
+
What forces act on the ball?
|
|
59
|
+
↓
|
|
60
|
+
Gravity, electromagnetic repulsion, and friction.
|
|
61
|
+
↓
|
|
62
|
+
How do we model friction?
|
|
63
|
+
↓
|
|
64
|
+
A coefficient? Isn't that arbitrary?
|
|
65
|
+
↓
|
|
66
|
+
Why not just model it?
|
|
67
|
+
↓
|
|
68
|
+
What exactly is friction?
|
|
69
|
+
↓
|
|
70
|
+
Oh, random microscopic interactions...
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
It's a mistake to assume it's impossible to model, but computational cost is prohibitive for most applications. Hence, you `abstract` it via empirical methods to measure friction, losing all but the necessary information.
|
|
74
|
+
|
|
75
|
+
But `abstract` isn't always the right model...
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
I want to research superconductors.
|
|
79
|
+
↓
|
|
80
|
+
Oh, my temperature range is 0 K to 200 K.
|
|
81
|
+
↓
|
|
82
|
+
Where do I get material definitions for that range?
|
|
83
|
+
↓
|
|
84
|
+
I'll just interpolate the standard Niobium definition.
|
|
85
|
+
↓
|
|
86
|
+
Actually, how were these measurements obtained?
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
When asking such a fundamental question, wouldn't it be best to derive the relations from what the material fundamentally is? Hence, you use `fundamental`, which describes what the material is, and build the necessary properties without measurement-implicit assumptions.
|
|
90
|
+
|
|
91
|
+
> [!IMPORTANT]
|
|
92
|
+
>
|
|
93
|
+
> PicoMats does not calculate material properties from the fundamental characteristics of the elements. It is up to the user to compute them via custom modelling or external frameworks.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
> [!NOTE]
|
|
98
|
+
>
|
|
99
|
+
> Both `abstract` and `fundamental` also make a good semantic boundary for model development. For example, `material.abstract.copper` and `material.fundamental.copper` explicitly denote the reality of their origin.
|
|
100
|
+
|
|
101
|
+
## Proposed workflow
|
|
102
|
+
|
|
103
|
+
PicoMats is still under development for `v0.1-alpha`. Implementation details and some abstractions may change.
|
|
104
|
+
|
|
105
|
+
```py
|
|
106
|
+
from picomats import mm
|
|
107
|
+
from picomats import Materials
|
|
108
|
+
|
|
109
|
+
# Pulls materials into the simulation
|
|
110
|
+
copper = Materials.abstract.pure.copper
|
|
111
|
+
|
|
112
|
+
density = copper.density
|
|
113
|
+
volume = 100 * mm ** 3
|
|
114
|
+
|
|
115
|
+
mass = volume * density
|
|
116
|
+
# > Output: 0.896 m(kg)
|
|
117
|
+
|
|
118
|
+
copper.assumptions.density
|
|
119
|
+
# > Output:
|
|
120
|
+
# >└── Method
|
|
121
|
+
# > ├── Hydrostatic Balance (Archimedes' Principle)
|
|
122
|
+
# > └── Media Type: Distilled Water
|
|
123
|
+
# >└── Assumptions
|
|
124
|
+
# > ├── Lack of air bubbles within media
|
|
125
|
+
# > └── Media temperature stability
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## Installation
|
|
129
|
+
|
|
130
|
+
Until release, this only installs the overview page and related files:
|
|
131
|
+
```bash
|
|
132
|
+
pip install PicoMats
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### Documentation
|
|
136
|
+
|
|
137
|
+
All internal documentation can be found within this repo's [issues](https://github.com/wgbowley/PicoMaterials/issues).
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "PicoMats"
|
|
7
|
+
version = "0.0.0"
|
|
8
|
+
description = "A unit-informed, assumption-driven material ontology."
|
|
9
|
+
|
|
10
|
+
readme = "README.md"
|
|
11
|
+
requires-python = ">=3.10"
|
|
12
|
+
license = { file = "LICENSE" }
|
|
13
|
+
keywords = ["materials", "physics", "units", "assumptions"]
|
|
14
|
+
|
|
15
|
+
authors = [
|
|
16
|
+
{ name = "William Bowley", email = "wgrantbowley@gmail.com" },
|
|
17
|
+
]
|
|
18
|
+
maintainers = [
|
|
19
|
+
{ name = "William Bowley", email = "wgrantbowley@gmail.com" },
|
|
20
|
+
]
|
|
21
|
+
|
|
22
|
+
dependencies = ["picounits", "numpy"]
|
|
23
|
+
|
|
24
|
+
classifiers = [
|
|
25
|
+
"Programming Language :: Python :: 3",
|
|
26
|
+
"License :: OSI Approved :: MIT License",
|
|
27
|
+
"Operating System :: OS Independent",
|
|
28
|
+
"Intended Audience :: Developers",
|
|
29
|
+
"Topic :: Scientific/Engineering",
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
[project.urls]
|
|
33
|
+
"Homepage" = "https://github.com/Bowley-Systems/PicoMats"
|
|
34
|
+
"Bug Tracker" = "https://github.com/Bowley-Systems/PicoMats/issues"
|
|
35
|
+
|
|
36
|
+
[tool.hatch.build.targets.wheel]
|
|
37
|
+
packages = ["src/picomats"]
|
|
38
|
+
include = [
|
|
39
|
+
"src/ontology/**/*",
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
[tool.hatch.build.targets.sdist]
|
|
43
|
+
include = [
|
|
44
|
+
"/src/ontology",
|
|
45
|
+
]
|
|
File without changes
|
|
File without changes
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# PicoMats Units - Derived from Base Dimensions (kg, m, s, etc)
|
|
2
|
+
|
|
3
|
+
[version]
|
|
4
|
+
format: 0.1.0
|
|
5
|
+
|
|
6
|
+
[Mechanics]
|
|
7
|
+
N: kg*m*s^-2
|
|
8
|
+
J: kg*m^2*s^-2
|
|
9
|
+
W: kg*m^2*s^-3
|
|
10
|
+
Pa: kg*m^-1*s^-2
|
|
11
|
+
|
|
12
|
+
[Electricity]
|
|
13
|
+
V: kg*m^2*s^-3*A^-1
|
|
14
|
+
F: kg^-1*m^-2*s^4*A^2
|
|
15
|
+
Ω: kg*m^2*s^-3*A^-2
|
|
16
|
+
S: kg^-1*m^-2*s^3*A^2
|
|
17
|
+
S_m: kg^-1*m^-3*s^3*A^2
|
|
18
|
+
|
|
19
|
+
[magnetic]
|
|
20
|
+
Wb: kg*m^2*s^-2*A^-1
|
|
21
|
+
T: kg*s^-2*A^-1
|
|
22
|
+
H: kg*m^2*s^-2*A^-2
|
|
23
|
+
A_m: A*m^-1
|
|
24
|
+
|
|
25
|
+
[Heat]
|
|
26
|
+
k: kg*m*s^-3*K^-1
|
|
27
|
+
c: m^2*s^-2*K^-1
|
|
28
|
+
|
|
29
|
+
[Other]
|
|
30
|
+
lm: cd
|
|
31
|
+
lx: cd*m^-2
|
|
32
|
+
Gy: m^2*s^-2
|
|
33
|
+
Sv: m^2*s^-2
|
|
34
|
+
kat: mol*s^-1
|