SOFT7

OTEAPI plugin

The soft7 packages comes with an OTEAPI plugin that allows one to convert any core parser data to a SOFT7 Entity instance.

To use the plugin, call the 'soft7' functionType function strategy.

Test the plugin

At the root of the repository is a Docker Compose file, which, when run, will start an OTEAPI Service that includes the soft7 OTEAPI plugin.

To start the service, run:

docker compose pull
docker compose up -d

To follow along with the installation of the soft7 package and startup of the OTEAPI Service, run:

docker logs -f soft7-oteapi-1

Press Ctrl+C to stop following the logs.

To eventually stop the services, run:

docker compose down

But first, let's test the plugin.

Open a Python shell, an IPython shell, or a Jupyter Notebook, and run:

from s7.factories import create_datasource

# Let us use an OPTIMADE structure from the Materials Project as our "raw" data source.
# The chosen structure is mp-1228448 (Al2O3):
# https://materialsproject.org/materials/mp-1228448/
# For more information about OPTIMADE, see https://www.optimade.org/
# For more information about the Materials Project, see https://materialsproject.org/
dataresource_config = {
    "downloadUrl": (
        "https://optimade.materialsproject.org/v1/structures/mp-1228448?"
        "response_format=json"
    ),
    "mediaType": "application/json",
}

# We need to setup a mapping configuration to tell the plugin how to map the OPTIMADE
# structure to a SOFT7 Entity instance.
# This requires knowledge of the OPTIMADE structure and the SOFT7 Entity.
# In our case the OPTIMADE structure specification is available at
# https://github.com/Materials-Consortia/OPTIMADE/blob/v1.1.0/optimade.rst#structures-entries
# and the SOFT7 Entity of choice is the `OPTIMADEStructure` Entity, which can be found
# at http://onto-ns.com/meta/1.0/OPTIMADEStructure
mapping_config = {
    "mappingType": "triples",
    "prefixes": {
        "optimade": "https://optimade.materialsproject.org/v1/structures/mp-1228448#",
        "soft7": "http://onto-ns.com/meta/1.0/OPTIMADEStructure#",
    },
    "triples": {
        ("optimade:data.id", "", "soft7:properties.id"),
        ("optimade:data.type", "", "soft7:properties.type"),
        ("optimade:data.attributes", "", "soft7:properties."),
    },
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

soft7-0.5.0.tar.gz (73.9 kB view details)

Uploaded Jun 2, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

soft7-0.5.0-py3-none-any.whl (38.4 kB view details)

Uploaded Jun 2, 2026 Python 3

File details

Details for the file soft7-0.5.0.tar.gz.

File metadata

Download URL: soft7-0.5.0.tar.gz
Upload date: Jun 2, 2026
Size: 73.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for soft7-0.5.0.tar.gz
Algorithm	Hash digest
SHA256	`ad3d774d9c2317a2e4e28c69ed0f0fd0b056026e19628a94c44a60899705c266`
MD5	`d6ac27e8b7d2e6b61070e7a3ae22dbba`
BLAKE2b-256	`d64934a4148f3930b2d40cd35278a1f515e3ed87217580b88dd7dd748f02bc19`

See more details on using hashes here.

Provenance

The following attestation bundles were made for soft7-0.5.0.tar.gz:

Publisher: cd_publish.yml on SINTEF/soft7

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: soft7-0.5.0.tar.gz
- Subject digest: ad3d774d9c2317a2e4e28c69ed0f0fd0b056026e19628a94c44a60899705c266
- Sigstore transparency entry: 1702049271
- Sigstore integration time: Jun 2, 2026
Source repository:
- Permalink: SINTEF/soft7@4327beff8cd4794bbd7a9de18dcc6f4184b27baa
- Branch / Tag: refs/tags/v0.5.0
- Owner: https://github.com/SINTEF
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: cd_publish.yml@4327beff8cd4794bbd7a9de18dcc6f4184b27baa
- Trigger Event: release