oghma_local: OghmaNano User Settings Directory

What is oghma_local?

The oghma_local directory is the user-specific working directory used by OghmaNano to store local copies of databases, program settings, cached data, scripts, temporary files and other information which belongs to the current user. Keeping this data outside the main OghmaNano installation directory allows each user to have their own settings and editable database copies without modifying the original files installed with OghmaNano.

How does data get into oghma_local?

When OghmaNano is started for the first time, user databases such as materials, spectra, shape and filters are copied from the OghmaNano installation directory, for example C:\(\backslash\)Program Files (x86)\(\backslash\)OghmaNano\(\backslash\), into oghma_local. Other files, such as settings, cache files and the recently used files list, are generated automatically as OghmaNano is used.

Any item in oghma_local can be reset by deleting it. The next time OghmaNano starts, the required file or directory will be regenerated or copied again from the installation directory where appropriate. This provides a simple way to recover from damaged settings, cached data or modified local databases without reinstalling OghmaNano.

Where can I find oghma_local?

On Windows, the oghma_local directory is stored inside the current user's profile directory rather than inside the read-only OghmaNano installation directory. It can normally be found at %USERPROFILE%\oghma_local.

For example, depending on the Windows user name, the directory may be located at:

• C:\Users\rod\oghma_local
• C:\Users\student\oghma_local
• C:\Users\researcher\oghma_local

The exact path depends on the Windows account which is running OghmaNano. For example, if your Windows user directory is C:\Users\rod, then your OghmaNano user settings directory will normally be C:\Users\rod\oghma_local.

oghma_local/cache

The cache directory is used to store cached simulation results generated by OghmaNano. When simulation result caching is enabled, completed results are stored here so that OghmaNano can reuse them rather than repeating the same calculation. This can be particularly useful for simulations which take a very long time to solve, for example large parameter scans or computationally expensive optical, electrical or multiphysics simulations. The cache does not contain essential user simulation data and can be deleted at any time if you wish to force OghmaNano to recalculate the results. A new cache directory will be generated when required.

oghma_local/data.json

The data.json file stores a broad range of user-specific OghmaNano configuration information. This includes settings such as the interface language, OpenCL device selection, graphical user interface options, icon configuration, cluster and compute settings, user information, window positions and other operating-system dependent preferences. The file is maintained automatically by OghmaNano and should normally not need to be edited manually. If it becomes damaged, or if you wish to reset these settings, it can be deleted and OghmaNano will generate a new data.json file the next time the program starts.

oghma_local/filters

The filters directory contains the user's local copy of the OghmaNano optical filters database. When OghmaNano is first started this database is copied from the filters database supplied in the installation directory. Changes made to filters through OghmaNano are made to this local copy. To restore the original filters database, delete the filters directory and restart OghmaNano. A clean copy will then be copied from the installation directory.

oghma_local/materials

The materials directory contains the user's local materials database. This includes material definitions and associated optical, electrical, thermal and other material data used by simulations. The directory is initially copied from the materials database installed with OghmaNano and may subsequently be edited or extended by the user. If the local materials database becomes damaged, delete the materials directory and restart OghmaNano to restore a fresh copy of the database supplied with the program.

oghma_local/morphology

The morphology directory stores user data associated with morphology definitions and morphology related functionality within OghmaNano. It forms part of the user's local data and may be recreated by OghmaNano when required. If the directory becomes damaged or contains unwanted local changes it can be deleted and regenerated on the next program start.

oghma_local/opencl_devices.json

The opencl_devices.json file stores information about OpenCL devices detected by OghmaNano. This allows the program to remember information about available GPU and accelerator devices between sessions. If the hardware configuration changes, or if the stored OpenCL information becomes invalid, the file can safely be deleted. OghmaNano will detect the available OpenCL devices again and generate a new file.

oghma_local/pictures

The pictures directory contains the user's local pictures database used by OghmaNano. These images are used primarily for testing optical simulations and imaging systems, allowing known input images and patterns to be passed through optical models and compared with the simulated output. The directory is copied or created in oghma_local so that the user can modify or add test images without changing the read-only copy supplied with the OghmaNano installation. Deleting the directory will cause OghmaNano to recreate or restore it on the next restart.

oghma_local/settings*.inp

The settings*.inp files store internal OghmaNano configuration and program state information used between sessions. These files are maintained automatically by OghmaNano and should not normally be edited by hand. Occasionally, after installing a new version of OghmaNano, deleting these files can help if old settings are causing unexpected behaviour. OghmaNano will recreate the required information the next time the program starts.

oghma_local/shape

The shape directory contains the user's local copy of the OghmaNano 3D shape and CAD model database. These shapes can be used when constructing device geometries, optical structures and other three-dimensional models within OghmaNano. The initial database is copied from the OghmaNano installation directory, allowing users to modify or add local shapes without changing the original installed files. To restore the supplied shape database, delete the local shape directory and restart OghmaNano.

oghma_local/spectra

The spectra directory contains the user's local optical spectra database, including illumination spectra used by optical and electrical simulations. It is initially copied from the spectra database supplied with OghmaNano. Users can add or modify spectra within this local copy. Deleting the spectra directory and restarting OghmaNano restores the database from the original installed copy.

oghma_local/tmp

The tmp directory is used for temporary files created while OghmaNano is running. Files in this directory are not intended to be permanent user data. If temporary files remain after a crash or interrupted simulation, the directory can be deleted. OghmaNano will create a new temporary directory when it is required.

oghma_local/updates

The updates directory stores data associated with OghmaNano database updates and downloaded content. It allows additional or updated database information to be managed separately from the read-only files supplied in the program installation. If the update data becomes damaged, the directory can be deleted and OghmaNano will recreate the required directory or download the data again when required.

oghma_local/used_files.inp

The used_files.inp file contains the list of recently used OghmaNano simulation files displayed by the graphical user interface. It is only a history file and does not contain simulation data. If the file contains invalid, obsolete or inaccessible file paths it can safely be deleted. OghmaNano will create a new used_files.inp file as new simulations are opened.