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.43.tar.gz (42.9 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.43-py2.py3-none-any.whl (37.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: pyoghma-0.0.43.tar.gz
  • Upload date:
  • Size: 42.9 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.43.tar.gz
Algorithm Hash digest
SHA256 64bdf9608cdd4511984c84203dbe2fcf8ec7b2b98513bb8721b5a964bbe0c841
MD5 3b104b52569fa5cd67eff181ba3cb8ff
BLAKE2b-256 08d97c81243ff93a924953b910f4c63702791bac6949dd66d8af92cdff3d3f87

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyoghma-0.0.43-py2.py3-none-any.whl
  • Upload date:
  • Size: 37.5 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.43-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4004d2a486a5cba8d30ec916a443456c983b639a257775fadb79fd072d26121a
MD5 a44483e03f1f5153588d7ce18970c91b
BLAKE2b-256 9328a62338fd537ec9c368774c6f5313da523485e88e0431c515c5367431f204

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