| Name | PyOghma JSON |
| Version |
0.0.17
JSON |
| download |
| home_page | None |
| Summary | A Python API for OghmaNano |
| upload_time | 2024-07-18 11:53:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyOghma
**This project is currently in the early stages and no gaurantiees are made to it working.**
A python API for OghmaNano allowing for the programmatic discription and exceution of drift-diffusion simulations.
## Installation
Prior to installing PyOghma it is critical that OghmaNano is installed. OghmaNano can be found to download at: [oghma-nano.com](https://www.oghma-nano.com)
PyOghma may be installed using pip
```bash
python -m pip install PyOghma
```
## Usage/Examples
In order to use PyOgham a soruce simulation generated by OghamNano must be generated, and the sim.json within sim.Oghma extracted. Once compleated modifications upon this simulation may be made programatically as in the example below by PyOghma.
```python
import PyOghma as po
Oghma = po.OghmaNano()
Results = po.Results()
source_simulation = "\exapmle\pm6y6\"
Oghma.set_source_simulation(source_simulation)
experiment_name = 'NewExperiment'
Oghma.set_experiment_name(experiment_name)
mobility = 1e-5
trap_desnsity = 1e-18
trapping_crosssection = 1e-20
recombination_crosssection = 1e-20
urbach_energy = 40e-3
temperature = 300
intensity = 0.5
experiment_name = 'NewExperiment' + str(1)
Oghma.clone('NewExperiment0')
Oghma.Optical.Light.set_light_Intensity(intensity)
Oghma.Optical.Light.update()
Oghma.Thermal.set_temperature(temperature)
Oghma.Thermal.update()
Oghma.Epitaxy.load_existing()
Oghma.Epitaxy.pm6y6.dos.mobility('both', mobility)
Oghma.Epitaxy.pm6y6.dos.trap_density('both', trap_desnsity)
Oghma.Epitaxy.pm6y6.dos.trapping_rate('both', 'free to trap',trapping_crosssection)
Oghma.Epitaxy.pm6y6.dos.trapping_rate('both', 'trap to free',recombination_crosssection)
Oghma.Epitaxy.pm6y6.dos.urbach_energy('both', urbach_energy)
Oghma.Epitaxy.update()
Oghma.add_job(experiment_name)
Oghma.run_jobs()
```
## Authors
- [@CaiWilliams](https://www.github.com/CaiWilliams)
Raw data
{
"_id": null,
"home_page": null,
"name": "PyOghma",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Cai Williams <cai.williams@physik.tu-chemnitz.de>",
"download_url": "https://files.pythonhosted.org/packages/78/13/f96ad088bf430d2fe4e8feae2dd32dde7b290eb95e96fb7795175d207043/pyoghma-0.0.17.tar.gz",
"platform": null,
"description": "\n# PyOghma\n**This project is currently in the early stages and no gaurantiees are made to it working.**\n\nA python API for OghmaNano allowing for the programmatic discription and exceution of drift-diffusion simulations.\n\n## Installation\nPrior to installing PyOghma it is critical that OghmaNano is installed. OghmaNano can be found to download at: [oghma-nano.com](https://www.oghma-nano.com)\n\nPyOghma may be installed using pip\n\n```bash\n python -m pip install PyOghma\n```\n \n## Usage/Examples\n\nIn order to use PyOgham a soruce simulation generated by OghamNano must be generated, and the sim.json within sim.Oghma extracted. Once compleated modifications upon this simulation may be made programatically as in the example below by PyOghma.\n\n```python\nimport PyOghma as po\n\nOghma = po.OghmaNano()\nResults = po.Results()\n\n\nsource_simulation = \"\\exapmle\\pm6y6\\\"\n\nOghma.set_source_simulation(source_simulation)\n\nexperiment_name = 'NewExperiment'\n\nOghma.set_experiment_name(experiment_name)\n\nmobility = 1e-5\ntrap_desnsity = 1e-18\ntrapping_crosssection = 1e-20\nrecombination_crosssection = 1e-20\nurbach_energy = 40e-3\ntemperature = 300\nintensity = 0.5\n\n\nexperiment_name = 'NewExperiment' + str(1)\nOghma.clone('NewExperiment0')\n\nOghma.Optical.Light.set_light_Intensity(intensity)\nOghma.Optical.Light.update()\n\nOghma.Thermal.set_temperature(temperature)\nOghma.Thermal.update()\n\nOghma.Epitaxy.load_existing()\nOghma.Epitaxy.pm6y6.dos.mobility('both', mobility)\nOghma.Epitaxy.pm6y6.dos.trap_density('both', trap_desnsity)\nOghma.Epitaxy.pm6y6.dos.trapping_rate('both', 'free to trap',trapping_crosssection)\nOghma.Epitaxy.pm6y6.dos.trapping_rate('both', 'trap to free',recombination_crosssection)\nOghma.Epitaxy.pm6y6.dos.urbach_energy('both', urbach_energy)\nOghma.Epitaxy.update()\n\nOghma.add_job(experiment_name)\nOghma.run_jobs()\n\n```\n\n\n## Authors\n\n- [@CaiWilliams](https://www.github.com/CaiWilliams)\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python API for OghmaNano",
"version": "0.0.17",
"project_urls": {
"Homepage": "https://github.com/CaiWilliams/pyOghma",
"Issues": "https://github.com/CaiWilliams/pyOghma/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "24e3a3da5028aa9281dcf739695c12e43294bba8deed7e2e51b71634a0506bfd",
"md5": "6fab1d0318d00eb71788dbbe7a584d43",
"sha256": "8eec50304832681e0f698c936705e0b96487c46d2836201ab3ec800d2316f377"
},
"downloads": -1,
"filename": "pyoghma-0.0.17-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fab1d0318d00eb71788dbbe7a584d43",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 34859,
"upload_time": "2024-07-18T11:53:44",
"upload_time_iso_8601": "2024-07-18T11:53:44.641714Z",
"url": "https://files.pythonhosted.org/packages/24/e3/a3da5028aa9281dcf739695c12e43294bba8deed7e2e51b71634a0506bfd/pyoghma-0.0.17-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7813f96ad088bf430d2fe4e8feae2dd32dde7b290eb95e96fb7795175d207043",
"md5": "33822a22c89fdbe312183b43d77f4dc5",
"sha256": "932d18cc99cd5e790516e7101f4a2cef9d4fd9f3d1c64394a8e1600a391e9507"
},
"downloads": -1,
"filename": "pyoghma-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "33822a22c89fdbe312183b43d77f4dc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 53155,
"upload_time": "2024-07-18T11:53:46",
"upload_time_iso_8601": "2024-07-18T11:53:46.364420Z",
"url": "https://files.pythonhosted.org/packages/78/13/f96ad088bf430d2fe4e8feae2dd32dde7b290eb95e96fb7795175d207043/pyoghma-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 11:53:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CaiWilliams",
"github_project": "pyOghma",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyoghma"
}
