ionworks-api 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

{ionworks_api-0.1.0.dist-info → ionworks_api-0.1.3.dist-info}/METADATA

@@ -1,13 +1,14 @@
 Metadata-Version: 2.4
 Name: ionworks-api
-Version: 0.1.0
+Version: 0.1.3
 Summary: Python client for interacting with the Ionworks API
+License-File: LICENSE.md
 Requires-Python: >=3.10
 Requires-Dist: black
 Requires-Dist: iwutil
 Requires-Dist: numpy
 Requires-Dist: pandas
-Requires-Dist: polars
+Requires-Dist: polars-lts-cpu
 Requires-Dist: pyarrow
 Requires-Dist: pybamm>=25.10.0
 Requires-Dist: pydantic>=2.6.0
@@ -17,6 +18,10 @@ Requires-Dist: supabase
 Requires-Dist: types-requests>=2.31.0
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo; extra == 'docs'
+Requires-Dist: myst-nb>=1.0.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
 Description-Content-Type: text/markdown
 
 # Ionworks API Client
@@ -34,7 +39,13 @@ A Python client for interacting with the Ionworks API.
 pip install -e .
 ```
 
-3. Get your API key from the [Ionworks account settings](https://app.ionworks.com/dashboard/account) and set it as the `IONWORKS_API_KEY` environment variable (or in a `.env` file).
+3. Copy the example environment file and fill in your credentials:
+
+```bash
+cp .env.example .env
+```
+
+Get your API key from the [Ionworks account settings](https://app.ionworks.com/dashboard/account) and your project ID from your project settings page. See [Environment Setup](#environment-setup) for details.
 
 ## Usage
 
@@ -185,7 +196,6 @@ Available element types:
 - `validation`: Validate model against data
 
 ```python
-import time
 from ionworks import Ionworks
 
 client = Ionworks()
@@ -236,22 +246,15 @@ pipeline_config = {
     },
 }
 
-# Submit pipeline
+# Submit pipeline and wait for completion
 pipeline = client.pipeline.create(pipeline_config)
 print(f"Pipeline submitted: {pipeline.id}")
 
-# Poll for completion
-while True:
-    pipeline = client.pipeline.get(pipeline.id)
-    print(f"Status: {pipeline.status}")
-    if pipeline.status == "completed":
-        result = client.pipeline.result(pipeline.id)
-        print("Fitted parameters:", result.element_results["fit data"])
-        break
-    elif pipeline.status == "failed":
-        print("Pipeline failed:", pipeline.error)
-        break
-    time.sleep(2)
+pipeline = client.pipeline.wait_for_completion(pipeline.id, timeout=600)
+
+if pipeline.status == "completed":
+    result = client.pipeline.result(pipeline.id)
+    print("Fitted parameters:", result.element_results["fit data"])
 ```
 
 ### Running simulations
@@ -307,6 +310,22 @@ simulation_data = client.simulation.get_result(result.simulation_id)
 time_series = simulation_data.get("time_series", {})
 ```
 
+## Environment Setup
+
+The client uses environment variables for configuration. Copy the example file and fill in your values:
+
+```bash
+cp .env.example .env
+```
+
+| Variable | Required | Default | Description |
+|---|---|---|---|
+| `IONWORKS_API_KEY` | Yes | — | API key from [account settings](https://app.ionworks.com/dashboard/account) |
+| `IONWORKS_API_URL` | No | `https://api.ionworks.com` | API base URL |
+| `PROJECT_ID` | For pipelines | — | Project ID from your project settings page |
+
+The client loads `.env` automatically via `python-dotenv`.
+
 ## Error Handling
 
 The client will raise exceptions in the following cases:

ionworks_api-0.1.3.dist-info/RECORD

@@ -0,0 +1,15 @@
+ionworks/__init__.py,sha256=dyCh0A5wTmk0Znq1F0fGm5b0uQJ_dpWPBsoL4A4pc7I,575
+ionworks/cell_instance.py,sha256=1ylUrh5HbqR5nwn8UNEuTuwxakHDoo6wSippNjeGE58,8046
+ionworks/cell_measurement.py,sha256=m4XLospN-RrmQhojpkSPr96ngwCW0-SkqbpsTEj_JKk,13366
+ionworks/cell_specification.py,sha256=fe3TlpRPZnU1V4vgo4oS4WyAzItJprW5FKiwHkHIbms,6420
+ionworks/client.py,sha256=laSKr0XFpXWz_xMXL2mGa0FVZd3t_G7oZoJokUc1l9I,5852
+ionworks/errors.py,sha256=zx1KoWGhMyA4Livokkt7kcB-dj0DEPIPA9AzaS3TESU,1491
+ionworks/job.py,sha256=1YZGM5d8UU8UIU2e6fQpap_6NU7E1gnD1OungXrWy30,4747
+ionworks/models.py,sha256=Zb_srLk1e7dt3juv0vE-6J8Pil08tbbJTJLoyZ0RCrs,4661
+ionworks/pipeline.py,sha256=vhMzXnZtdL0MxV_9TaEStIU0W-lFUhoP0remixhm374,11935
+ionworks/simulation.py,sha256=c9QSF8YBUSP90uEDzLU-ANLsyzVu4MY6wQBWuRfGciw,14982
+ionworks/validators.py,sha256=HKwVJzIAkKnWLXJVxw8M7hlG7qqgslqEuHN3yNaaA6s,22320
+ionworks_api-0.1.3.dist-info/METADATA,sha256=cM3CBDk8pvD4LzXuzMy91qbF365c170LxT6tQDDPbRE,9922
+ionworks_api-0.1.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ionworks_api-0.1.3.dist-info/licenses/LICENSE.md,sha256=MaRldz8wcFVJcX3KzjWwjj8QaFeFd3FwB0mB8hQMLQo,1082
+ionworks_api-0.1.3.dist-info/RECORD,,

ionworks_api-0.1.3.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ionworks Technologies Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ionworks_api-0.1.0.dist-info/RECORD

@@ -1,14 +0,0 @@
-ionworks/__init__.py,sha256=OCNLH4VyRyH8SVjrNf-XmeltpvDBcAqwSWVJ2y2YMcY,85
-ionworks/cell_instance.py,sha256=BGssFTos_U4EBVmbTRr-WjXmL5ZGu57c0FweEzM_QB4,7649
-ionworks/cell_measurement.py,sha256=DfcgQMMs6K9Rc0SFjXgC3jWo-nQ-Wff_Bk_1Qys2lAo,11918
-ionworks/cell_specification.py,sha256=mr_H3ppFWoEB4bwQb6SaX-OgZdACw2JEJvrfIKV_d8o,3944
-ionworks/client.py,sha256=PPX2TGrKC64phNKglZJvJPFJl8oEB5qrmsre8h27ltI,4842
-ionworks/errors.py,sha256=9aTLnXgusWnRaegkWMsfXj4EDnqQ8vbvv0C_QAzSWKU,972
-ionworks/job.py,sha256=0ZokfwjhX4kseM3dl3CPKB5jr6-MzYuNJU4DUn7bck8,3505
-ionworks/models.py,sha256=DIm69Q_9GuR-XVMvhyvqhrZQuWVB6puHb_Tr1R7a7D8,4581
-ionworks/pipeline.py,sha256=_nDHQRIrc_g-k_OnrkFnIyOVNlwlMZgrppB-9tiLPO0,8403
-ionworks/simulation.py,sha256=ZHbIAz4UVTloUismjNSzAqzzKOaF_QijZtAKuWc0lIg,13860
-ionworks/validators.py,sha256=84hIefvXYvndkezEgnnxxmFeyLvCSr3d0wcbX9wRAWM,5728
-ionworks_api-0.1.0.dist-info/METADATA,sha256=hNFyvwrWXLf9nnYdbgeoRy1k6lPR75sEathLS7NNqCU,9235
-ionworks_api-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-ionworks_api-0.1.0.dist-info/RECORD,,