# Petronas Common Utils
Welcome to the **Petronas Common Utils** repository. Here, you'll find essential source codes for basic and common utilities that can be applied accross multiple fields and areas within Petronas.
## Features
1. **Gas**
Within this category, you'll find functionalities tailored for the _natural gas refining_ sector. Some key components include:
* _Natural Gas_ - Allows you to define a gas and its composition and other functionalities such as unit conversion, gas treatment or gas blending.
Here's an example for unit conversion:
``` python
from petronas_common_utils.gas.natural_gas import NaturalGas, Component
# Create natural gas object
natural_gas = NaturalGas()
natural_gas.add_component(Component.C1, 0.9)
natural_gas.add_component(Component.C2, 0.05)
natural_gas.add_component(Component.C3, 0.03)
natural_gas.add_component(Component.C4, 0.01)
natural_gas.add_component(Component.C5, 0.005)
natural_gas.add_component(Component.CO2, 0.035)
natural_gas.build()
# Calculate amount for given component for a total flow of 10 tph
calculated_amount = natural_gas.get_amount(component=Component.C1, total_flow=(10, 'tph'), to_units='mmscfd')
```
2. **More categories and functionalities to be added soon.**
## Installation and usage
To install this package, simply use `pip install petronas-common-utils`.
**Additional detailed documentation on the different modules is expected to be included in subsequent versions**.
## Contribution
We welcome contributions! If you'd like to add new functionalities or improve existing ones, please follow our _contribution guidelines_.
Raw data
{
"_id": null,
"home_page": "https://github.com/MarcEscandell/petronas-common-utils",
"name": "petronas-common-utils",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "petronas-common-utils",
"author": "Marc Escandell Mari",
"author_email": "marc.escandellmari@petronas.com",
"download_url": "https://files.pythonhosted.org/packages/29/b7/72fdf177b3aabf99862fbd3df9cdf930ce66a6cc25330197956d0546ef16/petronas-common-utils-0.0.3.tar.gz",
"platform": null,
"description": "# Petronas Common Utils\n\nWelcome to the **Petronas Common Utils** repository. Here, you'll find essential source codes for basic and common utilities that can be applied accross multiple fields and areas within Petronas.\n\n## Features\n\n1. **Gas**\n\nWithin this category, you'll find functionalities tailored for the _natural gas refining_ sector. Some key components include:\n\n* _Natural Gas_ - Allows you to define a gas and its composition and other functionalities such as unit conversion, gas treatment or gas blending.\n Here's an example for unit conversion:\n\n ``` python\n from petronas_common_utils.gas.natural_gas import NaturalGas, Component\n\n\n # Create natural gas object\n natural_gas = NaturalGas()\n natural_gas.add_component(Component.C1, 0.9)\n natural_gas.add_component(Component.C2, 0.05)\n natural_gas.add_component(Component.C3, 0.03)\n natural_gas.add_component(Component.C4, 0.01)\n natural_gas.add_component(Component.C5, 0.005)\n natural_gas.add_component(Component.CO2, 0.035)\n natural_gas.build()\n\n # Calculate amount for given component for a total flow of 10 tph\n calculated_amount = natural_gas.get_amount(component=Component.C1, total_flow=(10, 'tph'), to_units='mmscfd')\n ```\n\n2. **More categories and functionalities to be added soon.**\n\n## Installation and usage\n\nTo install this package, simply use `pip install petronas-common-utils`.\n\n**Additional detailed documentation on the different modules is expected to be included in subsequent versions**.\n\n## Contribution\n\nWe welcome contributions! If you'd like to add new functionalities or improve existing ones, please follow our _contribution guidelines_.\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "A collection of reusable components and utilities for streamlining development across Petronas projects and submodules",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/MarcEscandell/petronas-common-utils"
},
"split_keywords": [
"petronas-common-utils"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e09b38ace4808c1147a1501dd209ac816d6881b0e6725d92e3a306f3be9dae7c",
"md5": "d7c77be25e09eb2ab19b536429fd29d5",
"sha256": "668b1d0ef40f03ef9dc0648a3e05eca8a95363ea87563c8a6b9321fd0bcc3fdd"
},
"downloads": -1,
"filename": "petronas_common_utils-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7c77be25e09eb2ab19b536429fd29d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 94942878,
"upload_time": "2023-08-30T09:49:50",
"upload_time_iso_8601": "2023-08-30T09:49:50.255586Z",
"url": "https://files.pythonhosted.org/packages/e0/9b/38ace4808c1147a1501dd209ac816d6881b0e6725d92e3a306f3be9dae7c/petronas_common_utils-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "29b772fdf177b3aabf99862fbd3df9cdf930ce66a6cc25330197956d0546ef16",
"md5": "211a3b9496cfac8e9c7163c720bdda23",
"sha256": "38da1bc878785f28a0c91149ecd4eed2be1247ac5b57140c7d1c1ebdca65b045"
},
"downloads": -1,
"filename": "petronas-common-utils-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "211a3b9496cfac8e9c7163c720bdda23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 94942144,
"upload_time": "2023-08-30T09:50:28",
"upload_time_iso_8601": "2023-08-30T09:50:28.966288Z",
"url": "https://files.pythonhosted.org/packages/29/b7/72fdf177b3aabf99862fbd3df9cdf930ce66a6cc25330197956d0546ef16/petronas-common-utils-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-30 09:50:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarcEscandell",
"github_project": "petronas-common-utils",
"github_not_found": true,
"lcname": "petronas-common-utils"
}
JSON
