# SCUBAS
SUCBAS: **S**ubmarine **C**ables **U**pset **b**y **A**uroral **S**treams.
## Installation
`scubas` includes both a reusuable Python package (intended to be imported and reused by other projects) and a set of scripts / notebooks using that package. How you should install `scubas` depends on how you intend to use it.
**If you want to run the interactive scripts / notebooks**, you should download this repository and install from it. **If you want to use the library in other projects**, you can either do that or just install the library from a package index or use `pip` installer.
### If you want to run the interactive notebooks
Make sure you have a recent Python version (*Python>=3.7*) and Jupyter installed.
Clone this repository into a suitable location on your computer:
`git clone https://github.com/shibaji7/SCUBAS`
`cd SCUBAS`
`pip install .`
You should now be able to open and run the notebooks within `scripts/` using Jupyter.
### If you want to use the library in other projects
#### From the Python Package Index:
The `scubas` package is distributed on the Python Package Index: https://pypi.org/project/scubas/
`pip install scubas`
#### From the git repository:
Follow the same instructions as installing the interactive notebooks.
## Folder Structure
- `scubas` - the python package
- `docs` - documentation for the codebase
- `scripts`, etc. - example analysis scripts and Jupyter notebooks
## Citing this Project
- Chakraborty S, Boteler DH, Shi X, Murphy BS, Hartinger MD, Wang X, Lucas G and Baker JBH (2022) Modeling geomagnetic induction in submarine cables. *Front. Phys.* 10:1022475. [doi:10.3389/fphy.2022.1022475](https://doi.org/10.3389/fphy.2022.1022475)
Raw data
{
"_id": null,
"home_page": "https://github.com/shibaji7/SCUBAS",
"name": "scubas",
"maintainer": "Shibaji Chakraborty",
"docs_url": null,
"requires_python": "",
"maintainer_email": "shibaji7@vt.edu",
"keywords": "Python>=3.6,submarine cable,electrical surge,geomagnetic induction,geomagnetic disturbance",
"author": "Shibaji Chakraborty",
"author_email": "shibaji7@vt.edu",
"download_url": "https://files.pythonhosted.org/packages/ca/c6/3cbd47c10d535e5361eb7513f96b1af70af1a9f72420884d37a1de6719de/scubas-0.1.5.tar.gz",
"platform": null,
"description": "# SCUBAS\nSUCBAS: **S**ubmarine **C**ables **U**pset **b**y **A**uroral **S**treams.\n\n## Installation\n`scubas` includes both a reusuable Python package (intended to be imported and reused by other projects) and a set of scripts / notebooks using that package. How you should install `scubas` depends on how you intend to use it.\n\n**If you want to run the interactive scripts / notebooks**, you should download this repository and install from it. **If you want to use the library in other projects**, you can either do that or just install the library from a package index or use `pip` installer.\n\n### If you want to run the interactive notebooks\n\nMake sure you have a recent Python version (*Python>=3.7*) and Jupyter installed.\n\nClone this repository into a suitable location on your computer:\n\n`git clone https://github.com/shibaji7/SCUBAS`\n\n`cd SCUBAS`\n\n`pip install .`\n\nYou should now be able to open and run the notebooks within `scripts/` using Jupyter.\n\n### If you want to use the library in other projects\n\n#### From the Python Package Index:\n\nThe `scubas` package is distributed on the Python Package Index: https://pypi.org/project/scubas/\n\n`pip install scubas`\n\n#### From the git repository:\n\nFollow the same instructions as installing the interactive notebooks.\n\n## Folder Structure\n\n- `scubas` - the python package\n- `docs` - documentation for the codebase\n- `scripts`, etc. - example analysis scripts and Jupyter notebooks\n\n## Citing this Project\n\n- Chakraborty S, Boteler DH, Shi X, Murphy BS, Hartinger MD, Wang X, Lucas G and Baker JBH (2022) Modeling geomagnetic induction in submarine cables. *Front. Phys.* 10:1022475. [doi:10.3389/fphy.2022.1022475](https://doi.org/10.3389/fphy.2022.1022475)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "SCUBAS: Submarine Cables Upset by Auroral Streams.",
"version": "0.1.5",
"project_urls": {
"Documentations": "https://scubas.readthedocs.io/en/latest/",
"Homepage": "https://github.com/shibaji7/SCUBAS"
},
"split_keywords": [
"python>=3.6",
"submarine cable",
"electrical surge",
"geomagnetic induction",
"geomagnetic disturbance"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d1ba042eea59a09ba8550a929f79073f20c13ca08fef572f33cf487ff604e643",
"md5": "e0fa0a03d6a3c22f836758fac6b8bb84",
"sha256": "74680a5c075b9f3603bddfc2205eb7d90fde026a2653e27da4c4e928fa70c337"
},
"downloads": -1,
"filename": "scubas-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0fa0a03d6a3c22f836758fac6b8bb84",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 20409,
"upload_time": "2024-01-31T19:20:08",
"upload_time_iso_8601": "2024-01-31T19:20:08.812355Z",
"url": "https://files.pythonhosted.org/packages/d1/ba/042eea59a09ba8550a929f79073f20c13ca08fef572f33cf487ff604e643/scubas-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cac63cbd47c10d535e5361eb7513f96b1af70af1a9f72420884d37a1de6719de",
"md5": "40345ec5f334aed517d3df3c13b9385e",
"sha256": "64bab558e34b06cb49ccba287a333c15281839cab6e3e40ed09aebba1848b935"
},
"downloads": -1,
"filename": "scubas-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "40345ec5f334aed517d3df3c13b9385e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19206,
"upload_time": "2024-01-31T19:20:13",
"upload_time_iso_8601": "2024-01-31T19:20:13.717100Z",
"url": "https://files.pythonhosted.org/packages/ca/c6/3cbd47c10d535e5361eb7513f96b1af70af1a9f72420884d37a1de6719de/scubas-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 19:20:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shibaji7",
"github_project": "SCUBAS",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scubas"
}
JSON
