Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/benediktburger/snlo-helper

An autoclicker to automatically configure and read SNLO.

https://github.com/benediktburger/snlo-helper

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.9%) to scientific vocabulary

Keywords

nlo optics-simulation snlo
Last synced: 6 months ago · JSON representation

Repository

An autoclicker to automatically configure and read SNLO.

Basic Info
  • Host: GitHub
  • Owner: BenediktBurger
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 83 KB
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 1
  • Open Issues: 1
  • Releases: 2
Topics
nlo optics-simulation snlo
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog License

README.md

SNLO-Helper

pypi release DOI Common Changelog

SNLO-Helper helps to use SNLO software for simulation of nonlinear optical processes in crystals.

An autoclicker clicks different buttons and fills fields in order to automate SNLO simulations. Afterwards, it can retrieve the results and return them as a dictionary.

Attention: - The script does use your mouse and keyboard, so you should not interact with the computer at the same time. - The script uses predefined positions of the windows, so do not move the windows. - The autoclicker can be interrupted by moving the mouse into the top left corner of the screen.

Currently it supports the following functions (feel free to add more): - Ref. Ind. - Qmix - 2D-mix-LP - 2D-mix-SP - PW-OPO-BB - 2D-cav-LP - Focus

Installation

Install it executing pip install -e . in this folder or via pip install snlo-helper to download it in the background and install it.

Usage

Quick Start

  1. Start SNLO on your computer
  2. Import snlohelper.main_window.MainWindow as a starting point.
  3. Create an instande mw = MainWindow
  4. Open the desired function: ri = mw.open_function(Functions.REF_INDEX)
  5. Execute it no, ne = ri.refractive_indices(Wavelength=1234)

Here is a small snippet how to do a 2D mix of long pulses: ``` from snlohelper.main_window import MainWindow

mw = MainWindow() mix = mw.opentwodmixlp() mix.configure({"Wavelengths (nm)": [1064.5, None, None]}) mix.accept() result = mix.runandread() print(result) ```

For more examples see the examples folder.

General usage

  • The main_window.MainWindow class manages the main window.
  • For several functions exists a module containing a class, which in turn allows to configure the function, to run the calculation, and to extract the result.
    1. You start that class, for example mix = two_d_mix_lp.TwoDMixLp() or mix = MainWindow().open_function("2D-Mix-LP").
    2. You can configure it giving a configuration dictionary (the keys correspond to the names) with mix.configure({"Wavelengths": [1064, None, None]}). If a value is None, it won't be changed.
    3. Click accept with mix.accept()
    4. You can run it with mix.run()
    5. With results = mix.read_results() you can extract the resulting text.
    6. With result_dict = mix.interpret_results(results) you get a dictionary of the result data
    7. There are convenience methods like mix.run_and_read which runs and returns the dictionary, or even mix.configure_run_read, which does all of above steps in one.

Contribution

You are welcome to contribute to this library. Just open an issue for suggestions or bug reports and open a pull request for code contributions.

Owner

  • Name: Benedikt Burger
  • Login: BenediktBurger
  • Kind: user
  • Location: Darmstadt
  • Company: TU Darmstadt

GitHub Events

Total
  • Watch event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Push event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: about 7 hours
  • Total issue authors: 1
  • Total pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 4
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • BenediktBurger (1)
Pull Request Authors
  • NoahDornhecker (4)
  • BenediktBurger (2)
Top Labels
Issue Labels
documentation (1) question (1)
Pull Request Labels
documentation (2)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 10 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
pypi.org: snlo-helper

An autoclicker to automatically configure and read SNLO.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 10 Last month
Rankings
Dependent packages count: 9.4%
Average: 35.8%
Dependent repos count: 62.3%
Maintainers (1)
bburger
Last synced: 6 months ago