| Name | siphotonics JSON |
| Version |
1.3.2
JSON |
| download |
| home_page | |
| Summary | A toolkit to design of silicon photonic components |
| upload_time | 2022-12-17 10:28:37 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.6 |
| license | MIT License Copyright (c) 2021 Emir Salih Mağden and Photonic Architecture Laboratories (PAL) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
photonics
nanophotonics
silicon photonics
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/Photonic-Architecture-Laboratories/siphotonics/actions/workflows/makefile.yml)
[](https://siphotonics.readthedocs.io/en/latest/?badge=latest)
# Siphotonics
## Getting Started
**Si-Photonics** is a toolkit providing fundamental waveguide and material properties to aid in the design of silicon photonic components on SOI platforms with high accuracy and extremely fast runtime. See the [documentation](https://siphotonics.readthedocs.io/en/latest/) for tutorials and API reference.
## Installation
### Pip
The package can be installed via pip:
pip install siphotonics
You can install siphotonics with additional packages for developers:
pip install siphotonics[dev]
### Build from source
Alternatively, the package can be built from source by cloning the repository and running the setup script:
git clone https://github.com/Photonic-Architecture-Laboratories/siphotonics.git
cd siphotonics
python setup.py install
## Dependencies
The package requires the following packages to be installed:
- [NumPy](https://numpy.org/)
- [Jax](https://jax.readthedocs.io/en/latest/index.html)
- [Trax](https://trax-ml.readthedocs.io/en/latest/)
## Citing SiPhotonics Toolkit
@software{siphotonics2022github,
url = {https://github.com/Photonic-Architecture-Laboratories/siphotonics},
author = {Aycan Deniz Vit, Emir Salih Mağden},
title = {SiPhotonics: A Python package for the design of silicon photonic components},
year = {2022},
version = {0.1.0},
}
Raw data
{
"_id": null,
"home_page": "",
"name": "siphotonics",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "photonics,nanophotonics,silicon photonics",
"author": "",
"author_email": "Aycan Deniz Vit <aycandv@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/e5/f2/c95eaa14fd7685e581c7a9e445b4ffa941f63c9dc60b5e795966750689db/siphotonics-1.3.2.tar.gz",
"platform": null,
"description": "[](https://github.com/Photonic-Architecture-Laboratories/siphotonics/actions/workflows/makefile.yml)\n[](https://siphotonics.readthedocs.io/en/latest/?badge=latest)\n\n# Siphotonics\n\n## Getting Started\n\n**Si-Photonics** is a toolkit providing fundamental waveguide and material properties to aid in the design of silicon photonic components on SOI platforms with high accuracy and extremely fast runtime. See the [documentation](https://siphotonics.readthedocs.io/en/latest/) for tutorials and API reference.\n\n## Installation\n\n### Pip\n\nThe package can be installed via pip:\n\n pip install siphotonics\n\nYou can install siphotonics with additional packages for developers:\n\n pip install siphotonics[dev]\n\n### Build from source\n\nAlternatively, the package can be built from source by cloning the repository and running the setup script:\n\n git clone https://github.com/Photonic-Architecture-Laboratories/siphotonics.git\n cd siphotonics\n python setup.py install\n\n##\u00a0Dependencies\n\nThe package requires the following packages to be installed:\n\n- [NumPy](https://numpy.org/)\n- [Jax](https://jax.readthedocs.io/en/latest/index.html)\n- [Trax](https://trax-ml.readthedocs.io/en/latest/)\n\n## Citing SiPhotonics Toolkit\n\n @software{siphotonics2022github,\n url = {https://github.com/Photonic-Architecture-Laboratories/siphotonics},\n author = {Aycan Deniz Vit, Emir Salih Ma\u011fden},\n title = {SiPhotonics: A Python package for the design of silicon photonic components},\n year = {2022}, \n version = {0.1.0},\n }\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Emir Salih Ma\u011fden and Photonic Architecture Laboratories (PAL) Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A toolkit to design of silicon photonic components",
"version": "1.3.2",
"split_keywords": [
"photonics",
"nanophotonics",
"silicon photonics"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "132b78eb72044190ec5476bd48204ea7",
"sha256": "ec36ee370f6bddfdfcced4d72efaa75f851449007638d290b30ccc3b500b4455"
},
"downloads": -1,
"filename": "siphotonics-1.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "132b78eb72044190ec5476bd48204ea7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 17439791,
"upload_time": "2022-12-17T10:28:34",
"upload_time_iso_8601": "2022-12-17T10:28:34.955942Z",
"url": "https://files.pythonhosted.org/packages/c3/4d/106776cda9165ede0b0e19f5cd16ad030864ba10e7b2ed3c6bb7cc91b972/siphotonics-1.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "ad22e5a6773f32c73fa0574fbff2cde4",
"sha256": "0760bc8f82a59c0e02c3aff1a7aa96d3efb71d4ab71eb543d791dbda64ccb6b8"
},
"downloads": -1,
"filename": "siphotonics-1.3.2.tar.gz",
"has_sig": false,
"md5_digest": "ad22e5a6773f32c73fa0574fbff2cde4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 17443977,
"upload_time": "2022-12-17T10:28:37",
"upload_time_iso_8601": "2022-12-17T10:28:37.755575Z",
"url": "https://files.pythonhosted.org/packages/e5/f2/c95eaa14fd7685e581c7a9e445b4ffa941f63c9dc60b5e795966750689db/siphotonics-1.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-17 10:28:37",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "siphotonics"
}
