nanohub-remote

Name	nanohub-remote JSON
Version	0.1.3 JSON
	download
home_page	https://github.com/denphi/nanohub-remote
Summary	A set of tools to run nanohub web apis
upload_time	2024-07-08 19:31:08
maintainer	None
docs_url	None
author	Project Jupyter contributor
requires_python	None
license	BSD
keywords	ipython
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Nanohub remote
# Stats

<table>
    <tr>
        <td>Latest Release</td>
        <td>
            <a href="https://pypi.org/project/nanohub-remote/"/>
            <img src="https://badge.fury.io/py/nanohub-remote.svg"/>
        </td>
    </tr>
    <tr>
        <td>PyPI Downloads</td>
        <td>
            <a href="https://pepy.tech/project/nanohub-remote"/>
            <img src="https://pepy.tech/badge/nanohub-remote/month"/>
            <img src="https://pepy.tech/badge/nanohub-remote"/>
        </td>
    </tr>
    <tr>
        <td>Nanohub Tutorial</td>
        <td>
            <a href='https://nanohub.org/tools/nhremote/invoke/5' target='_blank'><img src='https://img.shields.io/badge/nhremote-nanoHUB-5CA0BC.svg?style=&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbDpzcGFjZT0icHJlc2VydmUiIHdpZHRoPSI3OS43IiBoZWlnaHQ9IjgzIj48ZyBmaWxsPSIjRkZGIj48cGF0aCBkPSJtMzYgNDEgMS0zaDRsMSAzdjhsMSAxIDEgMWgydi05YzAtMyAwLTUtMi02bC01LTItNSAyLTIgNnY5aDRWNDF6Ii8+PHBhdGggZD0iTTcxIDM5Yy0zIDAtNiAxLTcgNGgtM2MwLTQtMS03LTMtMTBsNC0zIDQgMWE3IDcgMCAxIDAtNy01bC0zIDMtNy01di0xbDItNWgxYTggOCAwIDEgMC01LTJsLTIgNmEyMSAyMSAwIDAgMC0xMSAwbC0xLTNhNyA3IDAgMSAwLTQgMnYybDEgMWMtNCAxLTcgNC05IDdsLTMtMmE4IDggMCAxIDAtMiA0bDMgMmEyMSAyMSAwIDAgMC0xIDEwaC0xbC0zIDFhNyA3IDAgMSAwIDEgNGw0LTFjMSAzIDIgNiA1IDhsLTEgMS00IDQtMy0xYTggOCAwIDEgMCA3IDRsNC01YzMgMyA2IDQgMTEgNHY1Yy0zIDEtNCAzLTQgNiAwIDQgMyA3IDYgNyA0IDAgNy0zIDctNyAwLTMtMi02LTUtNnYtNWMzIDAgNy0yIDEwLTR2MWw0IDNhOCA4IDAgMSAwIDE1IDVjMC01LTQtOC04LThoLTRsLTMtMy0xLTFjMy0zIDQtNiA1LTEwaDRhNyA3IDAgMCAwIDE0LTFjMC00LTMtNy03LTd6bS01LTE3YTIgMiAwIDEgMSAwIDUgMiAyIDAgMCAxIDAtNXpNMTAgMzJhNCA0IDAgMSAxIDAtOCA0IDQgMCAwIDEgMCA4ek04IDUyYTIgMiAwIDEgMSAwLTUgMiAyIDAgMCAxIDAgNXptOCAyMmE0IDQgMCAxIDEgMC04IDQgNCAwIDAgMSAwIDh6bTQ3LTlhNCA0IDAgMSAxIDAgOCA0IDQgMCAwIDEgMC04ek01MiA2YTQgNCAwIDEgMSAwIDggNCA0IDAgMCAxIDAtOHpNMjggMTZhMiAyIDAgMSAxIDAtNCAyIDIgMCAwIDEgMCA0em0xMSAxMmExNSAxNSAwIDEgMSAwIDMwIDE1IDE1IDAgMCAxIDAtMzB6bTQgNDdhMiAyIDAgMSAxLTUgMCAyIDIgMCAwIDEgNSAwem0yOC0yNmEzIDMgMCAxIDEgMC02IDMgMyAwIDAgMSAwIDZ6Ii8+PC9nPjwvc3ZnPg=='></a>
        </td>
    </tr>
</table>
A set of tools/apps to run on nanohub

## Installation


```bashv
pip install nanohub-remote
```

## Usage


```python

import nanohubremote as nr
auth_data = {
  'client_id': XXXXXXXX,
  'client_secret': XXXXXXXX,
  'grant_type': 'password',
  'username': XXXXXXXX,
  'password': XXXXXXXX
}

# to get username and password, register on nanohub.org (https://nanohub.org/register/)
# to get client id and secret, create a web application (https://nanohub.org/developer/api/applications/new), use "https://127.0.0.1" as Redirect URL

session = nr.Session(auth_data)

```

## Available Nanohub Points

## Tools

```python
TOOLNAME = '' # valid Nanoohub tool name e.g. pntoy
tool = nr.Tool(auth_data)

# Get Available input parameters
params = tool.getToolParameters(TOOLNAME)

# Submit a simulation experiment
job_id = tool.submitTool(params)

# Check Status
status = tool.checkStatus(job_id['job_id'])

# Get Results
results = tool.getResults(job_id['job_id'])

# Submit an wait for results
results = tool.submitTool(params, wait_results=True)
```

## Sim2Ls

```python
TOOLNAME = '' # valid Nanoohub tool name e.g. pntoy
s2l = nr.Sim2L(auth_data)

# Get Available input parameters
params = s2l.getToolParameters(TOOLNAME)

# Submit a simulation experiment
job_id = s2l.submitTool(params)

# Check Status
status = s2l.checkStatus(job_id['job_id'])

# Get Results
results = s2l.getResults(job_id['job_id'])

# Submit an wait for results
results = s2l.submitTool(params, wait_results=True)
```







            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/denphi/nanohub-remote",
    "name": "nanohub-remote",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "IPython",
    "author": "Project Jupyter contributor",
    "author_email": "denphi@denphi.com",
    "download_url": null,
    "platform": "Linux",
    "description": "# Nanohub remote\n# Stats\n\n<table>\n    <tr>\n        <td>Latest Release</td>\n        <td>\n            <a href=\"https://pypi.org/project/nanohub-remote/\"/>\n            <img src=\"https://badge.fury.io/py/nanohub-remote.svg\"/>\n        </td>\n    </tr>\n    <tr>\n        <td>PyPI Downloads</td>\n        <td>\n            <a href=\"https://pepy.tech/project/nanohub-remote\"/>\n            <img src=\"https://pepy.tech/badge/nanohub-remote/month\"/>\n            <img src=\"https://pepy.tech/badge/nanohub-remote\"/>\n        </td>\n    </tr>\n    <tr>\n        <td>Nanohub Tutorial</td>\n        <td>\n            <a href='https://nanohub.org/tools/nhremote/invoke/5' target='_blank'><img src='https://img.shields.io/badge/nhremote-nanoHUB-5CA0BC.svg?style=&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbDpzcGFjZT0icHJlc2VydmUiIHdpZHRoPSI3OS43IiBoZWlnaHQ9IjgzIj48ZyBmaWxsPSIjRkZGIj48cGF0aCBkPSJtMzYgNDEgMS0zaDRsMSAzdjhsMSAxIDEgMWgydi05YzAtMyAwLTUtMi02bC01LTItNSAyLTIgNnY5aDRWNDF6Ii8+PHBhdGggZD0iTTcxIDM5Yy0zIDAtNiAxLTcgNGgtM2MwLTQtMS03LTMtMTBsNC0zIDQgMWE3IDcgMCAxIDAtNy01bC0zIDMtNy01di0xbDItNWgxYTggOCAwIDEgMC01LTJsLTIgNmEyMSAyMSAwIDAgMC0xMSAwbC0xLTNhNyA3IDAgMSAwLTQgMnYybDEgMWMtNCAxLTcgNC05IDdsLTMtMmE4IDggMCAxIDAtMiA0bDMgMmEyMSAyMSAwIDAgMC0xIDEwaC0xbC0zIDFhNyA3IDAgMSAwIDEgNGw0LTFjMSAzIDIgNiA1IDhsLTEgMS00IDQtMy0xYTggOCAwIDEgMCA3IDRsNC01YzMgMyA2IDQgMTEgNHY1Yy0zIDEtNCAzLTQgNiAwIDQgMyA3IDYgNyA0IDAgNy0zIDctNyAwLTMtMi02LTUtNnYtNWMzIDAgNy0yIDEwLTR2MWw0IDNhOCA4IDAgMSAwIDE1IDVjMC01LTQtOC04LThoLTRsLTMtMy0xLTFjMy0zIDQtNiA1LTEwaDRhNyA3IDAgMCAwIDE0LTFjMC00LTMtNy03LTd6bS01LTE3YTIgMiAwIDEgMSAwIDUgMiAyIDAgMCAxIDAtNXpNMTAgMzJhNCA0IDAgMSAxIDAtOCA0IDQgMCAwIDEgMCA4ek04IDUyYTIgMiAwIDEgMSAwLTUgMiAyIDAgMCAxIDAgNXptOCAyMmE0IDQgMCAxIDEgMC04IDQgNCAwIDAgMSAwIDh6bTQ3LTlhNCA0IDAgMSAxIDAgOCA0IDQgMCAwIDEgMC04ek01MiA2YTQgNCAwIDEgMSAwIDggNCA0IDAgMCAxIDAtOHpNMjggMTZhMiAyIDAgMSAxIDAtNCAyIDIgMCAwIDEgMCA0em0xMSAxMmExNSAxNSAwIDEgMSAwIDMwIDE1IDE1IDAgMCAxIDAtMzB6bTQgNDdhMiAyIDAgMSAxLTUgMCAyIDIgMCAwIDEgNSAwem0yOC0yNmEzIDMgMCAxIDEgMC02IDMgMyAwIDAgMSAwIDZ6Ii8+PC9nPjwvc3ZnPg=='></a>\n        </td>\n    </tr>\n</table>\nA set of tools/apps to run on nanohub\n\n## Installation\n\n\n```bashv\npip install nanohub-remote\n```\n\n## Usage\n\n\n```python\n\nimport nanohubremote as nr\nauth_data = {\n  'client_id': XXXXXXXX,\n  'client_secret': XXXXXXXX,\n  'grant_type': 'password',\n  'username': XXXXXXXX,\n  'password': XXXXXXXX\n}\n\n# to get username and password, register on nanohub.org (https://nanohub.org/register/)\n# to get client id and secret, create a web application (https://nanohub.org/developer/api/applications/new), use \"https://127.0.0.1\" as Redirect URL\n\nsession = nr.Session(auth_data)\n\n```\n\n## Available Nanohub Points\n\n## Tools\n\n```python\nTOOLNAME = '' # valid Nanoohub tool name e.g. pntoy\ntool = nr.Tool(auth_data)\n\n# Get Available input parameters\nparams = tool.getToolParameters(TOOLNAME)\n\n# Submit a simulation experiment\njob_id = tool.submitTool(params)\n\n# Check Status\nstatus = tool.checkStatus(job_id['job_id'])\n\n# Get Results\nresults = tool.getResults(job_id['job_id'])\n\n# Submit an wait for results\nresults = tool.submitTool(params, wait_results=True)\n```\n\n## Sim2Ls\n\n```python\nTOOLNAME = '' # valid Nanoohub tool name e.g. pntoy\ns2l = nr.Sim2L(auth_data)\n\n# Get Available input parameters\nparams = s2l.getToolParameters(TOOLNAME)\n\n# Submit a simulation experiment\njob_id = s2l.submitTool(params)\n\n# Check Status\nstatus = s2l.checkStatus(job_id['job_id'])\n\n# Get Results\nresults = s2l.getResults(job_id['job_id'])\n\n# Submit an wait for results\nresults = s2l.submitTool(params, wait_results=True)\n```\n\n\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "A set of tools to run nanohub web apis",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/denphi/nanohub-remote"
    },
    "split_keywords": [
        "ipython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "55a5021cd20db27ca099ff344b09112265a164d356e9e6a2761c5c155cae8d40",
                "md5": "2a3048dba9cb1d10adcd5d9a8a9db634",
                "sha256": "88deed1ee8bd0782a203e90a23d757fdaf2b1013d94fc389e38f19ceb9d21eb5"
            },
            "downloads": -1,
            "filename": "nanohub_remote-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2a3048dba9cb1d10adcd5d9a8a9db634",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 14295,
            "upload_time": "2024-07-08T19:31:08",
            "upload_time_iso_8601": "2024-07-08T19:31:08.553086Z",
            "url": "https://files.pythonhosted.org/packages/55/a5/021cd20db27ca099ff344b09112265a164d356e9e6a2761c5c155cae8d40/nanohub_remote-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-08 19:31:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "denphi",
    "github_project": "nanohub-remote",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "nanohub-remote"
}