semeio


Namesemeio JSON
Version 1.19.0 PyPI version JSON
download
home_pageNone
SummaryForward models and workflows for Ert.
upload_time2025-01-17 06:39:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPI version](https://badge.fury.io/py/semeio.svg)](https://badge.fury.io/py/semeio)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/semeio)](https://img.shields.io/pypi/pyversions/semeio)
[![Actions Status](https://github.com/equinor/semeio/workflows/CI/badge.svg)](https://github.com/equinor/semeio/actions?query=workflow=CI)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

# semeio #

Semeio is a collection of forward models and workflows used in [ERT](https://github.com/equinor/ert). These are
exposing end points which is considered the API of semeio. If there are submodules that can be applied
more generally, or have use outside these forward models and workflows, please create an issue and it can be exposed in
the API.

# Installation

Semeio is available on [pypi](https://pypi.org/project/semeio/) and can be installed using `pip install semeio`.

```sh
# Install
pip install semeio
```

# Usage

Once installed semeio will automatically register its workflows and forward models with
[ERT](https://github.com/equinor/ert). Through the plugin hooks it will also add its own documentation to the [ERT](https://github.com/equinor/ert)
documentation. See the [ERT](https://github.com/equinor/ert) documentation for examples on
how to run workflows and forward models, and build the [ERT](https://github.com/equinor/ert) documentation to get
documentation for the workflows and forward models.

# Run tests
To run the full test suite, do:

```sh
pip install ".[test]"
pytest tests
```

[pre-commit](https://pre-commit.com/) is used to comply with the formatting standards.
The complete formatting tests can be run with:

```sh
pip install ".[style]"
pre-commit run --all-files
```

Formatting use `ruff`, See `.pre-commit-config.yaml` for the
complete steps.

[pre-commit](https://pre-commit.com/) can also provide git hooks to run on every commit
to avoid commiting with formatting errors. This will only run on the diff so is quite fast.
To configure this, run:

```sh
pip install ".[style]"
pip install pre-commit
pre-commit install
```

After this the hook will run on every commit.

If you would like to remove the hooks, run:

```sh
pre-commit uninstall
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "semeio",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Equinor ASA <fg_sib-scout@equinor.com>",
    "download_url": "https://files.pythonhosted.org/packages/06/35/21e95810c0134fd701f67d1b22935dccf4bb6ff71d57c332aa1435ba8d79/semeio-1.19.0.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/semeio.svg)](https://badge.fury.io/py/semeio)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/semeio)](https://img.shields.io/pypi/pyversions/semeio)\n[![Actions Status](https://github.com/equinor/semeio/workflows/CI/badge.svg)](https://github.com/equinor/semeio/actions?query=workflow=CI)\n[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n# semeio #\n\nSemeio is a collection of forward models and workflows used in [ERT](https://github.com/equinor/ert). These are\nexposing end points which is considered the API of semeio. If there are submodules that can be applied\nmore generally, or have use outside these forward models and workflows, please create an issue and it can be exposed in\nthe API.\n\n# Installation\n\nSemeio is available on [pypi](https://pypi.org/project/semeio/) and can be installed using `pip install semeio`.\n\n```sh\n# Install\npip install semeio\n```\n\n# Usage\n\nOnce installed semeio will automatically register its workflows and forward models with\n[ERT](https://github.com/equinor/ert). Through the plugin hooks it will also add its own documentation to the [ERT](https://github.com/equinor/ert)\ndocumentation. See the [ERT](https://github.com/equinor/ert) documentation for examples on\nhow to run workflows and forward models, and build the [ERT](https://github.com/equinor/ert) documentation to get\ndocumentation for the workflows and forward models.\n\n# Run tests\nTo run the full test suite, do:\n\n```sh\npip install \".[test]\"\npytest tests\n```\n\n[pre-commit](https://pre-commit.com/) is used to comply with the formatting standards.\nThe complete formatting tests can be run with:\n\n```sh\npip install \".[style]\"\npre-commit run --all-files\n```\n\nFormatting use `ruff`, See `.pre-commit-config.yaml` for the\ncomplete steps.\n\n[pre-commit](https://pre-commit.com/) can also provide git hooks to run on every commit\nto avoid commiting with formatting errors. This will only run on the diff so is quite fast.\nTo configure this, run:\n\n```sh\npip install \".[style]\"\npip install pre-commit\npre-commit install\n```\n\nAfter this the hook will run on every commit.\n\nIf you would like to remove the hooks, run:\n\n```sh\npre-commit uninstall\n```\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "Forward models and workflows for Ert.",
    "version": "1.19.0",
    "project_urls": {
        "repository": "https://github.com/equinor/semeio"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "130ad340e11ba0a69f87cde56e29906f00f32dea78c2e216d1e4d85a6fbb4dca",
                "md5": "e568f6ae0840ebc714d00a7610b9ffd7",
                "sha256": "626530e2d44a97d32cec058077257e58015902f3c59b2640e702a22b265b7c2e"
            },
            "downloads": -1,
            "filename": "semeio-1.19.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e568f6ae0840ebc714d00a7610b9ffd7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 96753,
            "upload_time": "2025-01-17T06:39:15",
            "upload_time_iso_8601": "2025-01-17T06:39:15.420731Z",
            "url": "https://files.pythonhosted.org/packages/13/0a/d340e11ba0a69f87cde56e29906f00f32dea78c2e216d1e4d85a6fbb4dca/semeio-1.19.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "063521e95810c0134fd701f67d1b22935dccf4bb6ff71d57c332aa1435ba8d79",
                "md5": "08811de8c730abe23136a3cfc4540be8",
                "sha256": "71bfc0e4fe07fead26ad877cc858cc7c0f2f4f670192883bbb698c69537c1015"
            },
            "downloads": -1,
            "filename": "semeio-1.19.0.tar.gz",
            "has_sig": false,
            "md5_digest": "08811de8c730abe23136a3cfc4540be8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 18607390,
            "upload_time": "2025-01-17T06:39:18",
            "upload_time_iso_8601": "2025-01-17T06:39:18.429663Z",
            "url": "https://files.pythonhosted.org/packages/06/35/21e95810c0134fd701f67d1b22935dccf4bb6ff71d57c332aa1435ba8d79/semeio-1.19.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-17 06:39:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "equinor",
    "github_project": "semeio",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "semeio"
}
        
Elapsed time: 0.52175s