well-profile


Namewell-profile JSON
Version 0.8.1 PyPI version JSON
download
home_pagehttps://github.com/pro-well-plan/well_profile
SummaryWell Profile Builder
upload_time2023-11-06 21:03:36
maintainer
docs_urlNone
authorPro Well Plan AS
requires_python
licenseLGPL v3
keywords drilling well trajectory engineering
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            [![Cover](https://github.com/pro-well-plan/opensource_apps/raw/master/resources/pwp-bgd.gif)](https://prowellplan.com)

[![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/pro-well-plan/well_profile/blob/master/LICENSE.md)
[![PyPI version](https://badge.fury.io/py/well-profile.svg)](https://badge.fury.io/py/well-profile)
[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
[![Webapp](https://img.shields.io/badge/WebApp-On-green.svg)](https://share.streamlit.io/jcamiloangarita/opensource_apps/app.py)
[![Documentation Status](https://readthedocs.org/projects/well_profile/badge/?version=latest)](http://well_profile.readthedocs.io/?badge=latest)
[![Tests](https://github.com/pro-well-plan/well_profile/workflows/Tests/badge.svg)](https://github.com/pro-well-plan/well_profile/actions)
[![Downloads](https://pepy.tech/badge/well-profile)](https://pepy.tech/project/well-profile)


## Introduction
well_profile is a tool to generate or load well profiles in 3D. Features are added as they
are needed; suggestions and contributions of all kinds are very welcome.

## Documentation

See here for the [complete well_profile package documentation](https://well_profile.readthedocs.io/en/latest/).

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Get well_profile

* Users: Wheels for Python from [PyPI](https://pypi.python.org/pypi/well-profile/) 
    * `pip install well_profile`
* Developers: Source code from [Github](https://github.com/pro-well-plan/well_profile)
    * `git clone https://github.com/pro-well-plan/well_profile`
 
### Quick examples

Color by specified parameter: `e.g. 'dls'|'dl'|'tvd'|'md'|'inc'|'azi'`
```
import well_profile as wp
well = wp.load('trajectory1.xlsx')     # LOAD WELL
well.plot(style={'color': 'dls', 'size': 5}).show()
```
[![](https://user-images.githubusercontent.com/52009346/108047411-0e028580-7046-11eb-9de9-84c1cda2c903.png)](https://well-profile.readthedocs.io/en/latest/)

Also with dark mode:
```
well.plot(style={'darkMode': True, 'color': 'dls', 'size': 5}).show()
```
[![](https://user-images.githubusercontent.com/52009346/108048173-fed00780-7046-11eb-89f8-2a3b437b3047.png)](https://well-profile.readthedocs.io/en/latest/)

Plotting 3 wellbores:
* `Well 1 -> excel file: trajectory1.xlsx`
* `Well 2 -> generated well`
* `Well 3 -> excel file: trajectory2.xlsx`
```
import well_profile as wp
well_1 = wp.load('trajectory1.xlsx')      # LOAD WELL 1
well_2 = wp.get(6000, profile='J', kop=2000, eob=3000, build_angle=85, set_start={'east':2000})       # GET WELL 2 --> North: 0 m, East: 2000 m
well_3 = wp.load('trajectory2.xlsx', set_start={'north':-3000})        # LOAD WELL 3 --> North: -3000 m, East: 0 m
well_1.plot(add_well=[well_2, well_3],
            names=['first well name',
                   'second well name',
                   'third well name']).show()        # Generate 3D plot for well 1 including wells 2 and 3
```
<a href="https://youtu.be/X7Bs9_7NdRM">
   <img alt="Qries" src="https://well-profile.readthedocs.io/en/latest/_images/multiple_diff_loc.png"
   width=700" height="400">
</a>        

## Contributing

Please read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## History ##
This tool was initially written and is maintained by [Pro Well Plan
AS](http://www.prowellplan.com/) as a free, simple, easy-to-use way to perform
torque and drag calculations along the well that can be tailored to our needs, and as contribution to the
free software community.

## License

This project is licensed under the GNU Lesser General Public License v3.0 - see the [LICENSE](LICENSE.md) file for details


*for further information contact juan@prowellplan.com*

[![](https://user-images.githubusercontent.com/52009346/69100304-2eb3e800-0a5d-11ea-9a3a-8e502af2120b.png)](https://prowellplan.com)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/pro-well-plan/well_profile",
    "name": "well-profile",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "drilling,well,trajectory,engineering",
    "author": "Pro Well Plan AS",
    "author_email": "juan@prowellplan.com",
    "download_url": "https://files.pythonhosted.org/packages/db/12/84d3d3769842e064603031d6382035363ae1efe6c11913d7cd2d25abb90c/well_profile-0.8.1.tar.gz",
    "platform": null,
    "description": "[![Cover](https://github.com/pro-well-plan/opensource_apps/raw/master/resources/pwp-bgd.gif)](https://prowellplan.com)\r\n\r\n[![Open Source Love svg2](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/pro-well-plan/well_profile/blob/master/LICENSE.md)\r\n[![PyPI version](https://badge.fury.io/py/well-profile.svg)](https://badge.fury.io/py/well-profile)\r\n[![License: LGPL v3](https://img.shields.io/badge/License-LGPL_v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)\r\n[![Webapp](https://img.shields.io/badge/WebApp-On-green.svg)](https://share.streamlit.io/jcamiloangarita/opensource_apps/app.py)\r\n[![Documentation Status](https://readthedocs.org/projects/well_profile/badge/?version=latest)](http://well_profile.readthedocs.io/?badge=latest)\r\n[![Tests](https://github.com/pro-well-plan/well_profile/workflows/Tests/badge.svg)](https://github.com/pro-well-plan/well_profile/actions)\r\n[![Downloads](https://pepy.tech/badge/well-profile)](https://pepy.tech/project/well-profile)\r\n\r\n\r\n## Introduction\r\nwell_profile is a tool to generate or load well profiles in 3D. Features are added as they\r\nare needed; suggestions and contributions of all kinds are very welcome.\r\n\r\n## Documentation\r\n\r\nSee here for the [complete well_profile package documentation](https://well_profile.readthedocs.io/en/latest/).\r\n\r\n## Getting Started\r\n\r\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\r\n\r\n### Get well_profile\r\n\r\n* Users: Wheels for Python from [PyPI](https://pypi.python.org/pypi/well-profile/) \r\n    * `pip install well_profile`\r\n* Developers: Source code from [Github](https://github.com/pro-well-plan/well_profile)\r\n    * `git clone https://github.com/pro-well-plan/well_profile`\r\n \r\n### Quick examples\r\n\r\nColor by specified parameter: `e.g. 'dls'|'dl'|'tvd'|'md'|'inc'|'azi'`\r\n```\r\nimport well_profile as wp\r\nwell = wp.load('trajectory1.xlsx')     # LOAD WELL\r\nwell.plot(style={'color': 'dls', 'size': 5}).show()\r\n```\r\n[![](https://user-images.githubusercontent.com/52009346/108047411-0e028580-7046-11eb-9de9-84c1cda2c903.png)](https://well-profile.readthedocs.io/en/latest/)\r\n\r\nAlso with dark mode:\r\n```\r\nwell.plot(style={'darkMode': True, 'color': 'dls', 'size': 5}).show()\r\n```\r\n[![](https://user-images.githubusercontent.com/52009346/108048173-fed00780-7046-11eb-89f8-2a3b437b3047.png)](https://well-profile.readthedocs.io/en/latest/)\r\n\r\nPlotting 3 wellbores:\r\n* `Well 1 -> excel file: trajectory1.xlsx`\r\n* `Well 2 -> generated well`\r\n* `Well 3 -> excel file: trajectory2.xlsx`\r\n```\r\nimport well_profile as wp\r\nwell_1 = wp.load('trajectory1.xlsx')      # LOAD WELL 1\r\nwell_2 = wp.get(6000, profile='J', kop=2000, eob=3000, build_angle=85, set_start={'east':2000})       # GET WELL 2 --> North: 0 m, East: 2000 m\r\nwell_3 = wp.load('trajectory2.xlsx', set_start={'north':-3000})        # LOAD WELL 3 --> North: -3000 m, East: 0 m\r\nwell_1.plot(add_well=[well_2, well_3],\r\n            names=['first well name',\r\n                   'second well name',\r\n                   'third well name']).show()        # Generate 3D plot for well 1 including wells 2 and 3\r\n```\r\n<a href=\"https://youtu.be/X7Bs9_7NdRM\">\r\n   <img alt=\"Qries\" src=\"https://well-profile.readthedocs.io/en/latest/_images/multiple_diff_loc.png\"\r\n   width=700\" height=\"400\">\r\n</a>        \r\n\r\n## Contributing\r\n\r\nPlease read [CONTRIBUTING](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\r\n\r\n## History ##\r\nThis tool was initially written and is maintained by [Pro Well Plan\r\nAS](http://www.prowellplan.com/) as a free, simple, easy-to-use way to perform\r\ntorque and drag calculations along the well that can be tailored to our needs, and as contribution to the\r\nfree software community.\r\n\r\n## License\r\n\r\nThis project is licensed under the GNU Lesser General Public License v3.0 - see the [LICENSE](LICENSE.md) file for details\r\n\r\n\r\n*for further information contact juan@prowellplan.com*\r\n\r\n[![](https://user-images.githubusercontent.com/52009346/69100304-2eb3e800-0a5d-11ea-9a3a-8e502af2120b.png)](https://prowellplan.com)\r\n",
    "bugtrack_url": null,
    "license": "LGPL v3",
    "summary": "Well Profile Builder",
    "version": "0.8.1",
    "project_urls": {
        "Homepage": "https://github.com/pro-well-plan/well_profile"
    },
    "split_keywords": [
        "drilling",
        "well",
        "trajectory",
        "engineering"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "75dd6098de5ff9ede6b95bbd931a0c6b37c83a7a9bba69501ae1b486e64bcfd6",
                "md5": "914c051cc081e3fd1f24c7aeb1cd9850",
                "sha256": "5523d127c2a3ba34f31b6c9dfe0743b9cc6554cc35faead86a62c21109169529"
            },
            "downloads": -1,
            "filename": "well_profile-0.8.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "914c051cc081e3fd1f24c7aeb1cd9850",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 18302,
            "upload_time": "2023-11-06T21:03:34",
            "upload_time_iso_8601": "2023-11-06T21:03:34.271102Z",
            "url": "https://files.pythonhosted.org/packages/75/dd/6098de5ff9ede6b95bbd931a0c6b37c83a7a9bba69501ae1b486e64bcfd6/well_profile-0.8.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "db1284d3d3769842e064603031d6382035363ae1efe6c11913d7cd2d25abb90c",
                "md5": "578963832c55da3c046187ca80f80a97",
                "sha256": "15cdce660dcce20afcd4c220a472d80ef44a4d1ec7b387e4d569848f8b61666d"
            },
            "downloads": -1,
            "filename": "well_profile-0.8.1.tar.gz",
            "has_sig": false,
            "md5_digest": "578963832c55da3c046187ca80f80a97",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17793,
            "upload_time": "2023-11-06T21:03:36",
            "upload_time_iso_8601": "2023-11-06T21:03:36.218447Z",
            "url": "https://files.pythonhosted.org/packages/db/12/84d3d3769842e064603031d6382035363ae1efe6c11913d7cd2d25abb90c/well_profile-0.8.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-06 21:03:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pro-well-plan",
    "github_project": "well_profile",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "well-profile"
}
        
Elapsed time: 0.57989s