.. _auto_matml_importer:

*MATHML DATA IMPORTER*
======================

Connects to a MatML-compliant material data source via URL and imports structured material properties for use in calibration workflows. Provide a URL endpoint, optional API key, and query parameters to retrieve material data, then map raw MatML fields to platform material properties using the built-in mapper.

When to use
-----------

Tagged: ``calibration``, ``http_fetch``, ``keyvalue``, ``matML``, ``material_import``, ``material_library``, ``matml``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - URL
     - url
     - textarea
     - —
     - ✓
     - Full URL of the MatML data endpoint (e.g., a REST API or file server path) from which material data will be fetched; must be a valid HTTP/HTTPS address or resolvable URI.
   * - API_Key
     - api_key
     - text
     - —
     - 
     - Optional bearer or API key credential passed to the server for authenticated requests; leave blank if the endpoint is publicly accessible.
   * - Parameters
     - parameters
     - keyvalue
     - —
     - ✓
     - Key-value pairs appended as query parameters or request body fields sent to the MatML server (e.g., material ID, temperature range); at least one parameter is typically required to scope the query.
   * - Mapper
     - mapper
     - mapper
     - —
     - 
     - Field-mapping configuration that translates raw MatML parameter names to platform-standard material property keys; define mappings here to ensure downstream calibration workers receive correctly labelled properties.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Material Info
     - material_info
     - keyvalue
     - Key-value collection of imported material properties (e.g., density, yield strength, elastic modulus) as resolved from the MatML source after applying the mapper; consumed directly by calibration or material-library workers.

Disciplines
-----------

- data.dataset.ingest
- engineering.material.calibration
- engineering.material.library
- platform.integration

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>matml_importer</code>. Schema hash: <code>b6a989a9ca38</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>