# NeqSimAPI-connector
A python package to simplify calling NeqSimAPI for end-users handling authentication.
See https://neqsimapi.app.radix.equinor.com/docs for available endpoints.
# Usage
See [https://github.com/equinor/neqsimapi-connector/blob/main/example/demo.py](/example/demo.py) for a simple demo that connects and gets data from NeqSimAPI.
A short snippet is seen below
```
from neqsimapi_connector.Connector import Connector as neqsim_api_connector
data = {"compression_factor": 10,
"refrigerant": {
"fluid": "propane",
"fraction": 1,
"unit_temperature": "C",
"unit_pressure": "bara",
"unit_flowrate": "kg/hr",
"temperature": 30,
"pressure": 15,
"flowrate": 1000}
}
c = neqsim_api_connector()
res = c.post("DEMO/demo-process/simulate", data=data)
print(res)
```
# Install using pip
Usage of NeqSimAPI is limited to equinor users, but the package is available on pip.
```python -m pip neqsimapi_connector```
Raw data
{
"_id": null,
"home_page": "https://github.com/equinor/NeqSimAPI-connector",
"name": "neqsimapi-connector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "\u00c5smund V\u00e5ge Fannemel",
"author_email": "asmf@equinor.com",
"download_url": "https://files.pythonhosted.org/packages/9a/f5/aa6aa8548be1ebd9141c845bbfd9cb29a87fd1151965437d32743ccd8427/neqsimapi_connector-0.1.6.tar.gz",
"platform": null,
"description": "# NeqSimAPI-connector\nA python package to simplify calling NeqSimAPI for end-users handling authentication. \n\nSee https://neqsimapi.app.radix.equinor.com/docs for available endpoints.\n\n# Usage\nSee [https://github.com/equinor/neqsimapi-connector/blob/main/example/demo.py](/example/demo.py) for a simple demo that connects and gets data from NeqSimAPI.\n\nA short snippet is seen below\n```\nfrom neqsimapi_connector.Connector import Connector as neqsim_api_connector\n\ndata = {\"compression_factor\": 10,\n \"refrigerant\": {\n \"fluid\": \"propane\",\n \"fraction\": 1,\n \"unit_temperature\": \"C\",\n \"unit_pressure\": \"bara\",\n \"unit_flowrate\": \"kg/hr\",\n \"temperature\": 30,\n \"pressure\": 15,\n \"flowrate\": 1000}\n }\n\n\nc = neqsim_api_connector()\nres = c.post(\"DEMO/demo-process/simulate\", data=data)\nprint(res)\n```\n\n# Install using pip\nUsage of NeqSimAPI is limited to equinor users, but the package is available on pip. \n```python -m pip neqsimapi_connector```",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python package to simplify calling NeqSimAPI for end-users.",
"version": "0.1.6",
"project_urls": {
"Homepage": "https://github.com/equinor/NeqSimAPI-connector",
"Repository": "https://github.com/equinor/NeqSimAPI-connector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0f0ffffd13a8ceac955f317767604de667130f6a2422b97fe39e236e12cec73",
"md5": "fc870ebe622a8c13d40265525ccf6e97",
"sha256": "4e3fb4ae4209a20d9f36e7c7fa9de99633ec34580e63f7d2607d94369d5ae2d8"
},
"downloads": -1,
"filename": "neqsimapi_connector-0.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc870ebe622a8c13d40265525ccf6e97",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6,<4.0",
"size": 4735,
"upload_time": "2023-05-26T19:00:11",
"upload_time_iso_8601": "2023-05-26T19:00:11.477578Z",
"url": "https://files.pythonhosted.org/packages/d0/f0/ffffd13a8ceac955f317767604de667130f6a2422b97fe39e236e12cec73/neqsimapi_connector-0.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9af5aa6aa8548be1ebd9141c845bbfd9cb29a87fd1151965437d32743ccd8427",
"md5": "f0e3afe4fa9662802edd41e3fd7d15fe",
"sha256": "a4b06e3d5f316639dfb3bd0ce90df2ce7da5204fdc8e3c80a4fbcc9005398a5c"
},
"downloads": -1,
"filename": "neqsimapi_connector-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "f0e3afe4fa9662802edd41e3fd7d15fe",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6,<4.0",
"size": 3965,
"upload_time": "2023-05-26T19:00:14",
"upload_time_iso_8601": "2023-05-26T19:00:14.315557Z",
"url": "https://files.pythonhosted.org/packages/9a/f5/aa6aa8548be1ebd9141c845bbfd9cb29a87fd1151965437d32743ccd8427/neqsimapi_connector-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 19:00:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "NeqSimAPI-connector",
"github_not_found": true,
"lcname": "neqsimapi-connector"
}