Skip to main content

Compspec Flux

PyPI version

A compspec (Composition spec) is a specification and model for comparing things. Compspec Flux provides a simple means to extract metadata about a running flux instance, namely the graph of nodes. Other links of interest include:

  • Compspec: the Python library that discovers and loads this plugin.
  • Compatibility: of container images and applications to a host environment.
  • Compspec Go: the Go library that retrieves artifacts and makes graphs for image selection and scheduling.

Usage

Install compspec and the plugin here:

pip install compspec
pip install compspec-flux

Then (alongside a Flux instance) run the plugin. Note that the VSCode setup provided here will provide this for you. You can use defaults, or add any parameters to the plugin after the plugin name "flux" Here is how to start a flux instance:

flux start --test-size=4

And here is how to print to the terminal:

compspec extract flux
Flux output
{
    "graph": {
        "nodes": {
            "0": {
                "id": 0,
                "metadata": {
                    "type": "cluster",
                    "basename": "cluster",
                    "name": "cluster0",
                    "uniq_id": 0,
                    "containment": {
                        "paths": "/cluster0"
                    },
                    "size": 1,
                    "unit": "",
                    "rank": 0,
                    "exclusive": false
                }
            },
            "1": {
                "id": 1,
                "metadata": {
                    "type": "node",
                    "basename": "node",
                    "name": "node1",
                    "uniq_id": 1,
                    "containment": {
                        "paths": "/cluster0/node1"
                    },
                    "size": 1,
                    "unit": "",
                    "rank": 0,
                    "exclusive": false
                }
            }
        },
        "edges": [
            {
                "source": "0",
                "target": "1",
                "metadata": {
                    "name": {
                        "containment": "contains"
                    }
                }
            },
            {
                "source": "1",
                "target": "0",
                "metadata": {
                    "name": {
                        "containment": "in"
                    }
                }
            }
        ]
    }
}

And how to save to file

compspec extract --outfile cluster-resources.json flux

License

HPCIC DevTools is distributed under the terms of the MIT license. All new contributions must be made under this license.

See LICENSE, COPYRIGHT, and NOTICE for details.

SPDX-License-Identifier: (MIT)

LLNL-CODE- 842614

Metadata

Release files for compspec-flux 0.0.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for compspec-flux 0.0.11
File Size Uploaded
compspec-flux-0.0.11.tar.gz 7.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for compspec-flux 0.0.11
File Interpreter ABI Platform
compspec_flux-0.0.11-py3-none-any.whl Python 3 none any Details

Total release size: 15.9 kB

Release files / compspec-flux-0.0.11.tar.gz

Download URL compspec-flux-0.0.11.tar.gz
Size 7.8 kB
Tags Source
SHA-256 checksum
How to use checksums
5e66d1b698ed1b944f3fbc0af85b20869f6cdba0d9c6a00440c841f564e46b97
BLAKE2b-256 checksum
How to use checksums
ec6cbb128bb7fdeb6a065254cf198b0848a2e24ed06e7883cc6dd7cb846e71ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.5

Release files / compspec_flux-0.0.11-py3-none-any.whl

Download URL compspec_flux-0.0.11-py3-none-any.whl
Size 8.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
95c273ea14ec7d9850d62a09dec8f4b79a6aaafc738196fb12133f2ef95f2932
BLAKE2b-256 checksum
How to use checksums
bc0cdd6ec7785daba68edbb77a26cc025d774ac57850c814421d8756b25c7f15
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.5

Release history Release notifications | RSS feed

This release

0.0.11 This release

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page