# Completor®
Completor® is an Equinor developed Python Command Line Interface (CLI) for modeling wells with inflow control technology.
## Introduction
Completor® reads the multi-segmented tubing definition generated by reservoir modelling pre-processing tool and a user defined file (called "case" file) specifying the completion design.
The information in the input schedule file and the case file is combined
and written to a new schedule file to be included in your reservoir simulator.
## Documentation
Detailed documentation for usage of completor can be found at https://equinor.github.io/completor.
## Getting started as a user
### Prerequisites
* [Python](https://www.python.org/), version 3.11
* [ERT](https://github.com/equinor/ert) (optional, and only available on Linux.)
### Installation
To start using Completor®, you can follow these instructions:
```shell
git clone https://github.com/equinor/completor.git
cd completor
python3 -m venv venv
source venv/bin/activate
pip install -e .
```
If you intend to run completor as a plugin to ert:
```shell
git clone https://github.com/equinor/completor.git
cd completor
python -m venv venv
source venv/bin/activate
pip install -e ".[ert]"
```
Ensure it runs as intended, confirm it with:
```shell
completor --help
```
This should run for some time and display a help message.
### Create and run your first model
Some examples of Completor case file are available in [Examples](documentation/docs/about/examples.mdx) and detailed explanation is available in [Configuration](documentation/docs/about/configuration.mdx).
## Getting started as a contributor
### Contribution guide
We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation.
The preferred way of submitting a contribution is to either make an issue on GitHub or by forking the project on GitHub
and making a pull request.
See [Contribution Document](documentation/docs/contribution_guide.mdx) on how to contribute.
### Install completor as dev
In order to run Completor® you need to have versions of [Python 3.11](https://www.python.org/downloads/) installed.
#### Source code
Clone the [Completor® repository](https://github.com/equinor/completor) to get the source code.
```bash
git clone https://github.com/equinor/completor.git
cd completor
```
#### Pipx
[Install pipx](https://github.com/pypa/pipx#install-pipx), although it's optional next step assumes pipx is installed, check poetry docs for other installation options.
Linux:
```bash
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```
Windows:
```bash
python -m pip install --user pipx
# replace python with python3 if installed from Windows app store.
```
Mac:
```bash
brew install pipx
pipx ensurepath
```
#### Install Poetry:
For options other than pipx see [poetry documentation](https://python-poetry.org/docs/main/#installation)
Open a new terminal/tab then
```bash
pipx install poetry
```
Let Poetry install all dependencies for you.
```bash
poetry install
```
If you're in a Linux environment add the extra Ert dependencies!
```bash
poetry install -E ert
```
Activate poetryenv (or use venv if that is more familiar, poetry should respect it as an environment):
```bash
poetry shell
```
Now you should be able to check that everything is installed correctly by running
```bash
pytest
```
in the activated poetry shell.
Information regarding integration with PyCharm can be found here: https://www.jetbrains.com/help/pycharm/poetry.html#poetry-env
More info on viewing your environment information can be found here: https://python-poetry.org/docs/managing-environments/#switching-between-environments
Poetry support completion scripts for Bash, Fish and Zsh [detailed information can be found here](https://python-poetry.org/docs/#installing-with-pipx).
#### Pre-commit
This project makes use of pre-commit to ensure commits adhere to certain rules and standards.
Pre-commit should already be installed in the `poetry install` command, but you need to activate the hooks like so:
```bash
pre-commit install
```
If for some reason this is not working correctly you can install pre-commit separately like this:
```bash
pipx install pre-commit
pre-commit install
```
Now pre-commit should be a constant nuisance, bothering you with some minor change each time you want to commit.
Although annoying this is preferable to having lots of minor quirks in the code, such as trailing whitespace everywhere.
Just run git commit a second time, remembering to add the changes made by pre-commit and you should be mostly good!
> Git hook scripts are useful for identifying simple issues before submission to code review.
> Run hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements.
> By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.
> Black will style your code automatically to match the Black code style, and Flake8 will check your code for style, syntax, and logical errors.
> Remember to add the changes made by the scripts to your commit.
#### Running unit- and integration tests
This project uses [pytest](https://docs.pytest.org/en/stable/) for unit and integration testing.
Run it before every push to make sure your code is working as intended.
To run all tests discovered by pytest, run the following command when in the root folder
Recommended settings/launch args:
This makes the tests run in parallel and in turn go a bit more brrrr.
```bash
pytest -n auto
```
### Versioning
This project make use of [Release Please](https://github.com/googleapis/release-please) to keep track of versioning.
By following [conventional commit messages](https://www.conventionalcommits.org/en) (enforced) in PR titles, and squash-merging, the release please workflow will automatically create/update release-PRs based on which change is performed.
### Black and Flake8
This project uses [Black](https://pypi.org/project/black/) and [Flake8](https://pypi.org/project/flake8/) for code formatting and linting.
It deviates from the default black config by setting the max line length to 120 characters.
It might be helpful turn on format-on-save, and make black format your code on save.
A helpful visual aid is to set rulers in your editor to 120 characters.
Code should not exceed 120 characters.
Add this to you `settings.json` to set rulers in VSCode:
```json
{
"editor.rulers": [
120
],
"workbench.colorCustomizations": {
"editorRuler.foreground": "#33779944"
}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/equinor/completor",
"name": "completor",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Equinor ASA",
"author_email": "opensource@equinor.com",
"download_url": "https://files.pythonhosted.org/packages/0e/6d/f2f29b5ba5deda4f5713d2c68b2b18029921cf9f2dd99b01b11108b3ac3b/completor-1.1.2.tar.gz",
"platform": null,
"description": "# Completor\u00ae\nCompletor\u00ae is an Equinor developed Python Command Line Interface (CLI) for modeling wells with inflow control technology.\n\n## Introduction\nCompletor\u00ae reads the multi-segmented tubing definition generated by reservoir modelling pre-processing tool and a user defined file (called \"case\" file) specifying the completion design.\nThe information in the input schedule file and the case file is combined\nand written to a new schedule file to be included in your reservoir simulator.\n\n## Documentation\nDetailed documentation for usage of completor can be found at https://equinor.github.io/completor.\n\n## Getting started as a user\n\n### Prerequisites\n* [Python](https://www.python.org/), version 3.11\n* [ERT](https://github.com/equinor/ert) (optional, and only available on Linux.)\n\n### Installation\nTo start using Completor\u00ae, you can follow these instructions:\n\n```shell\ngit clone https://github.com/equinor/completor.git\ncd completor\npython3 -m venv venv\nsource venv/bin/activate\npip install -e .\n```\n\nIf you intend to run completor as a plugin to ert:\n```shell\ngit clone https://github.com/equinor/completor.git\ncd completor\npython -m venv venv\nsource venv/bin/activate\npip install -e \".[ert]\"\n```\n\nEnsure it runs as intended, confirm it with:\n```shell\ncompletor --help\n```\nThis should run for some time and display a help message.\n\n### Create and run your first model\nSome examples of Completor case file are available in [Examples](documentation/docs/about/examples.mdx) and detailed explanation is available in [Configuration](documentation/docs/about/configuration.mdx).\n\n## Getting started as a contributor\n### Contribution guide\nWe welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation.\nThe preferred way of submitting a contribution is to either make an issue on GitHub or by forking the project on GitHub\nand making a pull request.\n\nSee [Contribution Document](documentation/docs/contribution_guide.mdx) on how to contribute.\n\n### Install completor as dev\nIn order to run Completor\u00ae you need to have versions of [Python 3.11](https://www.python.org/downloads/) installed.\n#### Source code\nClone the [Completor\u00ae repository](https://github.com/equinor/completor) to get the source code.\n```bash\ngit clone https://github.com/equinor/completor.git\ncd completor\n```\n\n#### Pipx\n[Install pipx](https://github.com/pypa/pipx#install-pipx), although it's optional next step assumes pipx is installed, check poetry docs for other installation options.\n\nLinux:\n```bash\npython3 -m pip install --user pipx\npython3 -m pipx ensurepath\n```\nWindows:\n```bash\npython -m pip install --user pipx\n# replace python with python3 if installed from Windows app store.\n```\nMac:\n```bash\nbrew install pipx\npipx ensurepath\n```\n\n#### Install Poetry:\nFor options other than pipx see [poetry documentation](https://python-poetry.org/docs/main/#installation)\nOpen a new terminal/tab then\n```bash\npipx install poetry\n```\nLet Poetry install all dependencies for you.\n```bash\npoetry install\n```\nIf you're in a Linux environment add the extra Ert dependencies!\n```bash\npoetry install -E ert\n```\n\nActivate poetryenv (or use venv if that is more familiar, poetry should respect it as an environment):\n```bash\npoetry shell\n```\n\nNow you should be able to check that everything is installed correctly by running\n```bash\npytest\n```\nin the activated poetry shell.\n\nInformation regarding integration with PyCharm can be found here: https://www.jetbrains.com/help/pycharm/poetry.html#poetry-env\nMore info on viewing your environment information can be found here: https://python-poetry.org/docs/managing-environments/#switching-between-environments\n\nPoetry support completion scripts for Bash, Fish and Zsh [detailed information can be found here](https://python-poetry.org/docs/#installing-with-pipx).\n\n#### Pre-commit\n\nThis project makes use of pre-commit to ensure commits adhere to certain rules and standards.\nPre-commit should already be installed in the `poetry install` command, but you need to activate the hooks like so:\n```bash\npre-commit install\n```\n\nIf for some reason this is not working correctly you can install pre-commit separately like this:\n```bash\npipx install pre-commit\npre-commit install\n```\n\nNow pre-commit should be a constant nuisance, bothering you with some minor change each time you want to commit.\nAlthough annoying this is preferable to having lots of minor quirks in the code, such as trailing whitespace everywhere.\nJust run git commit a second time, remembering to add the changes made by pre-commit and you should be mostly good!\n\n> Git hook scripts are useful for identifying simple issues before submission to code review.\n> Run hooks on every commit to automatically point out issues in code such as missing semicolons, trailing whitespace, and debug statements.\n> By pointing these issues out before code review, this allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.\n> Black will style your code automatically to match the Black code style, and Flake8 will check your code for style, syntax, and logical errors.\n> Remember to add the changes made by the scripts to your commit.\n\n#### Running unit- and integration tests\n\nThis project uses [pytest](https://docs.pytest.org/en/stable/) for unit and integration testing.\nRun it before every push to make sure your code is working as intended.\nTo run all tests discovered by pytest, run the following command when in the root folder\n\nRecommended settings/launch args:\nThis makes the tests run in parallel and in turn go a bit more brrrr.\n```bash\npytest -n auto\n```\n\n### Versioning\nThis project make use of [Release Please](https://github.com/googleapis/release-please) to keep track of versioning.\nBy following [conventional commit messages](https://www.conventionalcommits.org/en) (enforced) in PR titles, and squash-merging, the release please workflow will automatically create/update release-PRs based on which change is performed.\n\n### Black and Flake8\nThis project uses [Black](https://pypi.org/project/black/) and [Flake8](https://pypi.org/project/flake8/) for code formatting and linting.\nIt deviates from the default black config by setting the max line length to 120 characters.\n\nIt might be helpful turn on format-on-save, and make black format your code on save.\n\nA helpful visual aid is to set rulers in your editor to 120 characters.\nCode should not exceed 120 characters.\nAdd this to you `settings.json` to set rulers in VSCode:\n\n```json\n{\n \"editor.rulers\": [\n 120\n ],\n \"workbench.colorCustomizations\": {\n \"editorRuler.foreground\": \"#33779944\"\n }\n}\n```\n\n",
"bugtrack_url": null,
"license": "LGPL-3.0-only",
"summary": "Advanced mulit-segmented well completion tool.",
"version": "1.1.2",
"project_urls": {
"Bug Tracker": "https://github.com/equinor/completor/issues",
"Documentation": "https://equinor.github.io/completor",
"Homepage": "https://github.com/equinor/completor",
"Repository": "https://github.com/equinor/completor"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4ec698b8d3030d74236c4f5bf9a6a0eee571f42fbd69571851e64518f17d55f4",
"md5": "80cfc64ca6c7dffd70ef2de2b35b3751",
"sha256": "8ca9e5cdcce3b7062cd8a2cd00878ab8db34b6841fcf9ce4b6dd76a086ac332f"
},
"downloads": -1,
"filename": "completor-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80cfc64ca6c7dffd70ef2de2b35b3751",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.11",
"size": 76964,
"upload_time": "2024-12-16T14:08:03",
"upload_time_iso_8601": "2024-12-16T14:08:03.786268Z",
"url": "https://files.pythonhosted.org/packages/4e/c6/98b8d3030d74236c4f5bf9a6a0eee571f42fbd69571851e64518f17d55f4/completor-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0e6df2f29b5ba5deda4f5713d2c68b2b18029921cf9f2dd99b01b11108b3ac3b",
"md5": "135c8b9e477847e6cec21e5527e3aecc",
"sha256": "1af2469ca3bf6d7f0e45cf6cab816e99bf1b63d705170cd61754cb4e7f3c5140"
},
"downloads": -1,
"filename": "completor-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "135c8b9e477847e6cec21e5527e3aecc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.11",
"size": 70249,
"upload_time": "2024-12-16T14:08:05",
"upload_time_iso_8601": "2024-12-16T14:08:05.174192Z",
"url": "https://files.pythonhosted.org/packages/0e/6d/f2f29b5ba5deda4f5713d2c68b2b18029921cf9f2dd99b01b11108b3ac3b/completor-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 14:08:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "completor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "completor"
}
JSON
