Skip to main content

A Python API for OghmaNano

Project description

PyOghma

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

PyOghma may be installed using pip

    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.

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyoghma-0.0.39.tar.gz (42.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyoghma-0.0.39-py2.py3-none-any.whl (37.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file pyoghma-0.0.39.tar.gz.

File metadata

  • Download URL: pyoghma-0.0.39.tar.gz
  • Upload date:
  • Size: 42.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for pyoghma-0.0.39.tar.gz
Algorithm Hash digest
SHA256 75cdcab4673524cf49d2a71946025c623406dc5a68dba348eab3d6576aecb695
MD5 194d11ab4dc20b6a2c22e1e228b31ba3
BLAKE2b-256 7b5c7d76bc96032bf21ce82e812bbf7423a1526b2e3c18e70c1f3391a78ed00f

See more details on using hashes here.

File details

Details for the file pyoghma-0.0.39-py2.py3-none-any.whl.

File metadata

  • Download URL: pyoghma-0.0.39-py2.py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.12

File hashes

Hashes for pyoghma-0.0.39-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8e1f032fa9c0ed02e6fbb1dce742b5cfde7bad5244456d35f2b233c81d4ab08f
MD5 7a42783b75dbeec9697e834aa6ac6046
BLAKE2b-256 e49440588145225c148c06d2d87c4726be478bc0e24f3068103c754ea702fd8c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page