Skip to main content

A Python API for OghmaNano

Project description

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

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.24.tar.gz (38.7 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.24-py2.py3-none-any.whl (35.0 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for pyoghma-0.0.24.tar.gz
Algorithm Hash digest
SHA256 6773895a54e21a65f1bd9e08dd078c91e1f62d30eb48f03db914a16a4efd44b8
MD5 55babbceb80dfac84f921116e3d00267
BLAKE2b-256 e74f83db0cfff81512ab9ceb8edc91cdd3ff6c1c34225859680e261e76c47709

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyoghma-0.0.24-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 20d7d0c75e0c65d8712b7f5daff70785ee2b5eba17891575d8255007dbc539f2
MD5 51156f4480675634a774b79cdd85c02f
BLAKE2b-256 e3e3e789e0b766522248b231b8aae54ada6c499d52a0068b4b8333b6913b7d44

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