Metadata-Version: 2.4
Name: nomad-ml-workflows
Version: 1.0.0
Summary: A NOMAD plugin for managing ML workflows.
Author-email: Sarthak Kapoor <sarthak.kapoor@physik.hu-berlin.de>, Sharat Patil <patilsha@physik.hu-berlin.de>
Maintainer-email: Sarthak Kapoor <sarthak.kapoor@physik.hu-berlin.de>
Project-URL: Repository, https://github.com/FAIRmat-NFDI/nomad-ml-workflows
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nomad-lab>=2.0.0
Requires-Dist: huggingface-hub
Requires-Dist: pydantic
Requires-Dist: temporalio
Provides-Extra: dev
Requires-Dist: nomad-lab[infrastructure]>=2.0.0; extra == "dev"
Requires-Dist: nomad-ml-workflows[cpu-action]; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: structlog; extra == "dev"
Requires-Dist: mkdocs; extra == "dev"
Requires-Dist: mkdocs-material>=9.5.0; extra == "dev"
Requires-Dist: pymdown-extensions; extra == "dev"
Requires-Dist: mkdocs-click; extra == "dev"
Requires-Dist: pytest-asyncio; extra == "dev"
Requires-Dist: poethepoet; extra == "dev"
Provides-Extra: cpu-action
Requires-Dist: pyarrow; extra == "cpu-action"
Requires-Dist: boto3; extra == "cpu-action"
Requires-Dist: nomad-forces-export>=0.1.1; extra == "cpu-action"
Dynamic: license-file

# nomad-ml-workflows

A NOMAD plugin for exporting datasets and describing machine learning models.

- **Export Entries:** Export complete archives or selected paths as JSON, CSV, or Parquet.
- **Export Forces:** Export atomic structures with energies, forces, and stresses as Extended XYZ or an ASE database.
- **Export Remote Entries:** Export datasets from configured Oases to S3, optionally copying them into an upload on the deployment that starts the action.
- **MLModel and Dataset schemas:** Describe model artifacts, training data, and evaluation metadata.

## 📦 Installation

Install the plugin with its export-worker dependencies:

```sh
pip install 'nomad-ml-workflows[cpu-action]'
```

Export actions require a configured NOMAD deployment and a running CPU action worker.

## 📚 Documentation

See the [documentation](https://fairmat-nfdi.github.io/nomad-ml-workflows/) for the GUI and REST tutorial, action guides, deployment configuration, and schema examples.

## 🛠️ Contributing

See [Contribute to this plugin](https://fairmat-nfdi.github.io/nomad-ml-workflows/how_to/contribute_to_this_plugin.html) for development setup, tests, linting, and documentation previews.

## License

Licensed under the MIT License. See [LICENSE](LICENSE).
