Skip to content

Commit 2b91d21

Browse files
committed
Release 0.0.61
1 parent 8ab5236 commit 2b91d21

30 files changed

+958
-69
lines changed

.github/workflows/ci.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
- name: Set up python
1111
uses: actions/setup-python@v4
1212
with:
13-
python-version: "3.10"
13+
python-version: 3.8
1414
- name: Bootstrap poetry
1515
run: |
1616
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -26,7 +26,7 @@ jobs:
2626
- name: Set up python
2727
uses: actions/setup-python@v4
2828
with:
29-
python-version: "3.10"
29+
python-version: 3.8
3030
- name: Bootstrap poetry
3131
run: |
3232
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
@@ -46,7 +46,7 @@ jobs:
4646
- name: Set up python
4747
uses: actions/setup-python@v4
4848
with:
49-
python-version: "3.10"
49+
python-version: 3.8
5050
- name: Bootstrap poetry
5151
run: |
5252
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "axiomatic"
33

44
[tool.poetry]
55
name = "axiomatic"
6-
version = "0.0.60"
6+
version = "0.0.61"
77
description = ""
88
readme = "README.md"
99
authors = []
@@ -34,7 +34,7 @@ packages = [
3434
Repository = 'https://github.com/axiomatic-ai/axiomatic-python-sdk'
3535

3636
[tool.poetry.dependencies]
37-
python = "^3.10"
37+
python = "^3.8"
3838
httpx = ">=0.21.2"
3939
pydantic = ">= 1.9.2"
4040
pydantic-core = "^2.18.2"

reference.md

Lines changed: 238 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -745,6 +745,156 @@ core.File` — See core.File for more documentation
745745
</dl>
746746

747747

748+
</dd>
749+
</dl>
750+
</details>
751+
752+
## Tools
753+
<details><summary><code>client.tools.<a href="src/axiomatic/tools/client.py">schedule</a>(...)</code></summary>
754+
<dl>
755+
<dd>
756+
757+
#### 📝 Description
758+
759+
<dl>
760+
<dd>
761+
762+
<dl>
763+
<dd>
764+
765+
Schedule a job to execute python code for long running executions and return the standard output. If an error occurs, it will be returned in the error_trace field. The Following tools are currently supported: fdtd, femwell, optiland, jaxfem
766+
</dd>
767+
</dl>
768+
</dd>
769+
</dl>
770+
771+
#### 🔌 Usage
772+
773+
<dl>
774+
<dd>
775+
776+
<dl>
777+
<dd>
778+
779+
```python
780+
from axiomatic import Axiomatic
781+
782+
client = Axiomatic(
783+
api_key="YOUR_API_KEY",
784+
)
785+
client.tools.schedule(
786+
tool_name="tool_name",
787+
code="code",
788+
)
789+
790+
```
791+
</dd>
792+
</dl>
793+
</dd>
794+
</dl>
795+
796+
#### ⚙️ Parameters
797+
798+
<dl>
799+
<dd>
800+
801+
<dl>
802+
<dd>
803+
804+
**tool_name:** `str`
805+
806+
</dd>
807+
</dl>
808+
809+
<dl>
810+
<dd>
811+
812+
**code:** `str`
813+
814+
</dd>
815+
</dl>
816+
817+
<dl>
818+
<dd>
819+
820+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
821+
822+
</dd>
823+
</dl>
824+
</dd>
825+
</dl>
826+
827+
828+
</dd>
829+
</dl>
830+
</details>
831+
832+
<details><summary><code>client.tools.<a href="src/axiomatic/tools/client.py">status</a>(...)</code></summary>
833+
<dl>
834+
<dd>
835+
836+
#### 📝 Description
837+
838+
<dl>
839+
<dd>
840+
841+
<dl>
842+
<dd>
843+
844+
Get the status of the remote execution job for a given tool using the job_id
845+
</dd>
846+
</dl>
847+
</dd>
848+
</dl>
849+
850+
#### 🔌 Usage
851+
852+
<dl>
853+
<dd>
854+
855+
<dl>
856+
<dd>
857+
858+
```python
859+
from axiomatic import Axiomatic
860+
861+
client = Axiomatic(
862+
api_key="YOUR_API_KEY",
863+
)
864+
client.tools.status(
865+
job_id="job_id",
866+
)
867+
868+
```
869+
</dd>
870+
</dl>
871+
</dd>
872+
</dl>
873+
874+
#### ⚙️ Parameters
875+
876+
<dl>
877+
<dd>
878+
879+
<dl>
880+
<dd>
881+
882+
**job_id:** `str`
883+
884+
</dd>
885+
</dl>
886+
887+
<dl>
888+
<dd>
889+
890+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
891+
892+
</dd>
893+
</dl>
894+
</dd>
895+
</dl>
896+
897+
748898
</dd>
749899
</dl>
750900
</details>
@@ -1849,6 +1999,94 @@ client.pic.circuit.placementoptimize(
18491999
</dl>
18502000

18512001

2002+
</dd>
2003+
</dl>
2004+
</details>
2005+
2006+
<details><summary><code>client.pic.circuit.<a href="src/axiomatic/pic/circuit/client.py">get_sax_spectrum</a>(...)</code></summary>
2007+
<dl>
2008+
<dd>
2009+
2010+
#### 📝 Description
2011+
2012+
<dl>
2013+
<dd>
2014+
2015+
<dl>
2016+
<dd>
2017+
2018+
Get the spectrum of a circuit over various wavelengths and settings
2019+
</dd>
2020+
</dl>
2021+
</dd>
2022+
</dl>
2023+
2024+
#### 🔌 Usage
2025+
2026+
<dl>
2027+
<dd>
2028+
2029+
<dl>
2030+
<dd>
2031+
2032+
```python
2033+
from axiomatic import Axiomatic, Netlist
2034+
2035+
client = Axiomatic(
2036+
api_key="YOUR_API_KEY",
2037+
)
2038+
client.pic.circuit.get_sax_spectrum(
2039+
netlist=Netlist(),
2040+
settings={"key": "value"},
2041+
wls=[1.1],
2042+
)
2043+
2044+
```
2045+
</dd>
2046+
</dl>
2047+
</dd>
2048+
</dl>
2049+
2050+
#### ⚙️ Parameters
2051+
2052+
<dl>
2053+
<dd>
2054+
2055+
<dl>
2056+
<dd>
2057+
2058+
**netlist:** `Netlist`
2059+
2060+
</dd>
2061+
</dl>
2062+
2063+
<dl>
2064+
<dd>
2065+
2066+
**settings:** `Settings`
2067+
2068+
</dd>
2069+
</dl>
2070+
2071+
<dl>
2072+
<dd>
2073+
2074+
**wls:** `typing.Sequence[float]`
2075+
2076+
</dd>
2077+
</dl>
2078+
2079+
<dl>
2080+
<dd>
2081+
2082+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
2083+
2084+
</dd>
2085+
</dl>
2086+
</dd>
2087+
</dl>
2088+
2089+
18522090
</dd>
18532091
</dl>
18542092
</details>

src/axiomatic/__init__.py

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@
1414
GenerateCodeResponse,
1515
GenerateComponentCodeResponse,
1616
GenerateLensCodeResponse,
17+
GetSpectrumResponse,
18+
GetSpectrumResponseSpectrumItemValue,
19+
GetSpectrumResponseSpectrumItemValueImag,
20+
GetSpectrumResponseSpectrumItemValueItem,
21+
GetSpectrumResponseSpectrumOneValue,
22+
GetSpectrumResponseSpectrumOneValueImag,
23+
GetSpectrumResponseSpectrumOneValueItem,
1724
HttpValidationError,
1825
InteractiveResponse,
1926
Net,
@@ -32,11 +39,14 @@
3239
PicWarnings,
3340
RefineCodeResponse,
3441
RefineComponentCodeResponse,
42+
ScheduleJobResponse,
3543
SolutionResponse,
3644
SolutionResponseSolutionValue,
45+
Spectrum,
3746
StatementDictionary,
3847
StatementValidation,
3948
StatementValidationDictionary,
49+
StatusResponse,
4050
StructureConstraint,
4151
StructureFunctionCall,
4252
StructureFunctionCallArgumentsValue,
@@ -50,11 +60,10 @@
5060
ValidationErrorLocItem,
5161
VerifyCircuitCodeResponse,
5262
VerifyResponse,
53-
Z3ExpressionInput,
54-
Z3ExpressionOutput,
63+
Z3Expression,
5564
)
5665
from .errors import UnprocessableEntityError
57-
from . import code_execution, document, experimental, formalization, fso, generic, lean, pic, requirements
66+
from . import code_execution, document, experimental, formalization, fso, generic, lean, pic, requirements, tools
5867
from .client import AsyncAxiomatic, Axiomatic
5968
from .environment import AxiomaticEnvironment
6069
from .version import __version__
@@ -76,6 +85,13 @@
7685
"GenerateCodeResponse",
7786
"GenerateComponentCodeResponse",
7887
"GenerateLensCodeResponse",
88+
"GetSpectrumResponse",
89+
"GetSpectrumResponseSpectrumItemValue",
90+
"GetSpectrumResponseSpectrumItemValueImag",
91+
"GetSpectrumResponseSpectrumItemValueItem",
92+
"GetSpectrumResponseSpectrumOneValue",
93+
"GetSpectrumResponseSpectrumOneValueImag",
94+
"GetSpectrumResponseSpectrumOneValueItem",
7995
"HttpValidationError",
8096
"InteractiveResponse",
8197
"Net",
@@ -94,11 +110,14 @@
94110
"PicWarnings",
95111
"RefineCodeResponse",
96112
"RefineComponentCodeResponse",
113+
"ScheduleJobResponse",
97114
"SolutionResponse",
98115
"SolutionResponseSolutionValue",
116+
"Spectrum",
99117
"StatementDictionary",
100118
"StatementValidation",
101119
"StatementValidationDictionary",
120+
"StatusResponse",
102121
"StructureConstraint",
103122
"StructureFunctionCall",
104123
"StructureFunctionCallArgumentsValue",
@@ -113,8 +132,7 @@
113132
"ValidationErrorLocItem",
114133
"VerifyCircuitCodeResponse",
115134
"VerifyResponse",
116-
"Z3ExpressionInput",
117-
"Z3ExpressionOutput",
135+
"Z3Expression",
118136
"__version__",
119137
"code_execution",
120138
"document",
@@ -125,4 +143,5 @@
125143
"lean",
126144
"pic",
127145
"requirements",
146+
"tools",
128147
]

0 commit comments

Comments
 (0)