CoreDataX 0.10.0__tar.gz → 0.10.2__tar.gz

{coredatax-0.10.0 → coredatax-0.10.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: CoreDataX
-Version: 0.10.0
+Version: 0.10.2
 Summary: API for uploading data to the PSMA's CoreDataeXchange project.
 Project-URL: Homepage, https://coredatax.com
 Project-URL: Repository, https://github.com/CoreDataX/CoreDataX
@@ -55,21 +55,30 @@ A header row is required. These columns must be present:
 | column | unit | meaning |
 | --- | --- | --- |
 | `magneticReference` | — | the reference of a magnetic already registered in CoreDataX |
+| `setupReference` | — | the measurement setup; stored as the record's `setup` and `methodUsed` |
 | `frequency` | Hz | excitation frequency |
 | `magneticFluxDensityPeak` | T | peak flux density |
+| `magneticFieldDcBias` | T | DC bias of the flux density (0 for symmetric excitation) |
+| `magneticFieldWaveformType` | — | `sinusoidal`, `triangular`, `rectangular`, … (PEAS 1.0 spelling; the older `Sinusoidal`/`Square` names are still accepted and converted) |
 | `temperature` | °C | ambient temperature |
 | `volumetricLosses` | W/m³ | measured core losses per unit volume |
 
-Optional: `setupReference`, `magneticFieldDcBias` (A/m), `magneticFieldWaveformType`
-(e.g. `Sinusoidal`). Up to 10 000 rows per call. Rows are attributed to the
-authenticated user — a `userId` column is ignored.
+Optional: `dutyCycle` (for non-sinusoidal excitation). Up to 10 000 rows per call.
+Rows are attributed to the authenticated user — a `userId` column is ignored.
+
+The excitation columns are not decoration: `magneticFieldWaveformType`,
+`magneticFieldDcBias` and `dutyCycle` become `label`, `offset` and `dutyCycle` on
+the stored CDX document, which is what CoreDataX reads back as `waveform`,
+`dcBias` and `dutyCycle` — a measurement with no waveform label is dropped from
+the Herbert curves.
 
 ```csv
 magneticReference,setupReference,frequency,magneticFluxDensityPeak,magneticFieldDcBias,magneticFieldWaveformType,temperature,volumetricLosses
-3C90 --- TX-25-15-10,my-setup,100000,0.1,0,Sinusoidal,25,42000
+3C90 --- TX-25-15-10,my-setup,100000,0.1,0,sinusoidal,25,42000
 ```
 
-A row the server rejects (unknown magnetic reference, unparseable number) does not
+A row the server rejects (unknown magnetic reference, unparseable number, a waveform
+name it does not recognise) does not
 abort the upload — it comes back in `errors` with its CSV line number, while the
 good rows are stored.
 

{coredatax-0.10.0 → coredatax-0.10.2}/README.md

@@ -33,21 +33,30 @@ A header row is required. These columns must be present:
 | column | unit | meaning |
 | --- | --- | --- |
 | `magneticReference` | — | the reference of a magnetic already registered in CoreDataX |
+| `setupReference` | — | the measurement setup; stored as the record's `setup` and `methodUsed` |
 | `frequency` | Hz | excitation frequency |
 | `magneticFluxDensityPeak` | T | peak flux density |
+| `magneticFieldDcBias` | T | DC bias of the flux density (0 for symmetric excitation) |
+| `magneticFieldWaveformType` | — | `sinusoidal`, `triangular`, `rectangular`, … (PEAS 1.0 spelling; the older `Sinusoidal`/`Square` names are still accepted and converted) |
 | `temperature` | °C | ambient temperature |
 | `volumetricLosses` | W/m³ | measured core losses per unit volume |
 
-Optional: `setupReference`, `magneticFieldDcBias` (A/m), `magneticFieldWaveformType`
-(e.g. `Sinusoidal`). Up to 10 000 rows per call. Rows are attributed to the
-authenticated user — a `userId` column is ignored.
+Optional: `dutyCycle` (for non-sinusoidal excitation). Up to 10 000 rows per call.
+Rows are attributed to the authenticated user — a `userId` column is ignored.
+
+The excitation columns are not decoration: `magneticFieldWaveformType`,
+`magneticFieldDcBias` and `dutyCycle` become `label`, `offset` and `dutyCycle` on
+the stored CDX document, which is what CoreDataX reads back as `waveform`,
+`dcBias` and `dutyCycle` — a measurement with no waveform label is dropped from
+the Herbert curves.
 
 ```csv
 magneticReference,setupReference,frequency,magneticFluxDensityPeak,magneticFieldDcBias,magneticFieldWaveformType,temperature,volumetricLosses
-3C90 --- TX-25-15-10,my-setup,100000,0.1,0,Sinusoidal,25,42000
+3C90 --- TX-25-15-10,my-setup,100000,0.1,0,sinusoidal,25,42000
 ```
 
-A row the server rejects (unknown magnetic reference, unparseable number) does not
+A row the server rejects (unknown magnetic reference, unparseable number, a waveform
+name it does not recognise) does not
 abort the upload — it comes back in `errors` with its CSV line number, while the
 good rows are stored.
 

{coredatax-0.10.0 → coredatax-0.10.2}/api/CoreDataX/__init__.py

@@ -14,7 +14,7 @@ from .client import (
     upload_csv,
 )
 
-__version__ = "0.10.0"
+__version__ = "0.10.2"
 
 __all__ = [
     "Client",

{coredatax-0.10.0 → coredatax-0.10.2}/api/CoreDataX/client.py

@@ -20,12 +20,17 @@ import requests
 
 DEFAULT_BASE_URL = "https://coredatax.com"
 
-#: Columns every uploaded CSV must carry (extra columns are allowed:
-#: ``setupReference``, ``magneticFieldDcBias``, ``magneticFieldWaveformType``).
+#: Columns every uploaded CSV must carry. The excitation ones are not
+#: decoration: they become label / offset on the stored CDX document, which is
+#: what CoreDataX reads back as waveform / dcBias -- a measurement without them
+#: is dropped from the Herbert curves. ``dutyCycle`` is the one optional extra.
 REQUIRED_CSV_COLUMNS = (
     "magneticReference",
+    "setupReference",
     "frequency",
     "magneticFluxDensityPeak",
+    "magneticFieldDcBias",
+    "magneticFieldWaveformType",
     "temperature",
     "volumetricLosses",
 )
@@ -98,12 +103,11 @@ class Client:
     def upload_csv(self, csv):
         """Upload measurements from a CSV file path, file object, or CSV text.
 
-        The CSV needs a header row with at least ``magneticReference``,
-        ``frequency``, ``magneticFluxDensityPeak``, ``temperature`` and
-        ``volumetricLosses``; ``setupReference``, ``magneticFieldDcBias`` and
-        ``magneticFieldWaveformType`` are used when present. Max 10 000 rows
-        per call. The rows are attributed to the authenticated user -- a
-        ``userId`` column, if any, is ignored.
+        The CSV needs a header row carrying every column in
+        :data:`REQUIRED_CSV_COLUMNS`; ``dutyCycle`` may be added for
+        non-sinusoidal excitation. Max 10 000 rows per call. The rows are
+        attributed to the authenticated user -- a ``userId`` column, if any,
+        is ignored.
 
         Returns the server's ``{'success', 'inserted', 'errors'}``; ``errors``
         holds one entry per rejected row (with its 1-based CSV line number).

coredatax-0.10.2/api/CoreDataX/example.csv

@@ -0,0 +1,4 @@
+magneticReference,setupReference,frequency,magneticFluxDensityPeak,magneticFieldDcBias,magneticFieldWaveformType,temperature,volumetricLosses,userId
+3C94 --- TX-20-10-7,My setup,112160,0.0885929,0,triangular,25,87198.16,1
+3C94 --- TX-20-10-7,My setup,112160,0.0990441,0,triangular,25,114103.336,1
+3C94 --- TX-20-10-7,My setup,112160,0.110654,0,triangular,25,150794.77,1

{coredatax-0.10.0 → coredatax-0.10.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "CoreDataX"
-version = "0.10.0"
+version = "0.10.2"
 description = "API for uploading data to the PSMA's CoreDataeXchange project."
 readme = "README.md"
 requires-python = ">=3.8"

coredatax-0.10.0/api/CoreDataX/example.csv

@@ -1,4 +0,0 @@
-magneticReference,setupReference,frequency,magneticFluxDensityPeak,magneticFieldDcBias,magneticFieldWaveformType,temperature,volumetricLosses,userId
-3C94 --- TX-20-10-7,My setup,112160,0.0885929,0,Triangular,25,87198.16,1
-3C94 --- TX-20-10-7,My setup,112160,0.0990441,0,Triangular,25,114103.336,1
-3C94 --- TX-20-10-7,My setup,112160,0.110654,0,Triangular,25,150794.77,1