https://github.com/equinor/semeio

Semeio is a collection of jobs and workflow jobs used in ert (https://github.com/equinor/ert).
https://github.com/equinor/semeio

ert hacktoberfest python

Last synced: 7 days ago
JSON representation

Semeio is a collection of jobs and workflow jobs used in ert (https://github.com/equinor/ert).

• Host: GitHub
• URL: https://github.com/equinor/semeio
• Owner: equinor
• License: gpl-3.0
• Created: 2019-11-25T08:41:34.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-12-18T08:34:28.000Z (about 1 month ago)
• Last Synced: 2025-01-06T19:13:51.292Z (14 days ago)
• Topics: ert, hacktoberfest, python
• Language: Python
• Homepage: https://github.com/equinor/semeio
• Size: 21.4 MB
• Stars: 10
• Watchers: 14
• Forks: 29
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![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

```