Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: BRaulier
  • License: other
  • Language: Python
  • Default Branch: main
  • Size: 4.86 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

HE60-PyMagister:

PyMagister is a Python interface of Hydro Light MacOS version. It is useful to bypass the graphic user interface of HydroLight. It is then possible to run many simulations without any human intervention. This Python interface is also intented to work with a modified version of HydroLight that includes a "SeaIceIOP" mode. This homemade mode enables the use of depth dependant discretized phase function (dddpf).

Please note that knowledge of HydroLight is necessary in order to fully exploit the features of this interface.

Installation

Download zip file and use the package manager pip to install package. bash pip3 install [path/to/extracted/zip]

Classes calling scheme

image info

SeaIceSimulation

Examples

python from HE60PY.seaicesimulation import SeaIceSimulation simple_example_SeaIce =SeaIceSimulation(run_title='simple_example_SeaIce', root_name='simple_example_SeaIce') simple_example_SeaIce.set_z_grid(z_max=2.0) simple_example_SeaIce.add_layer(z1=0.0, z2=0.10, abs=0.5, scat=100, dpf='dpf_OTHG_0_98.txt') simple_example_SeaIce.add_layer(z1=0.10, z2=0.5, abs=0.5, scat=100, dpf='dpf_OTHG_0_98.txt') simple_example_SeaIce.add_layer(z1=0.5, z2=2.01, abs=0.4, scat=200, dpf='dpf_OTHG_0_98.txt') simple_example_SeaIce.run_simulation(printoutput=True)

python from HE60PY.seaicesimulation import SeaIceSimulation example_SeaIce = SeaIceSimulation(run_title='example_SeaIce', root_name='example_SeaIce') example_SeaIce.set_z_grid(z_max=3.00, wavelength_list=[484, 544, 602]) example_SeaIce.add_layer(z1=0.0, z2=0.20, abs={'484': 0.0430, '544': 0.0683, '602': 0.12}, scat=2277, dpf='dpf_OTHG_0_95.txt') example_SeaIce.add_layer(z1=0.20, z2=0.80, abs={'484': 0.0430, '544': 0.0683, '602': 0.12}, scat=303, dpf='dpf_OTHG_0_98.txt') example_SeaIce.add_layer(z1=0.80, z2=2.00, abs={'484': 0.0430, '544': 0.0683, '602': 0.12}, scat=79, dpf='dpf_OTHG_0_98.txt') example_SeaIce.add_layer(z1=2.0, z2=3.01, abs={'484': 1.36e-2, '544': 5.11e-2, '602': 2.224e-1}, scat=0.1, dpf='dpf_OTHG_0_98.txt') example_SeaIce.run_simulation(printoutput=True)

AC9Simulation

Calling example

Acknowledgements

I would like to thank Dr John Hedley, founder of Numerical Optics Ltd, who was very generous in answering my many questions about Hydro Light and its operation.

For questions and comments please see Bastian Raulier, Takuvik Joint International Team, Université Laval, Quebec City, contact.

Owner

  • Name: Bastian Raulier
  • Login: BRaulier
  • Kind: user
  • Location: Québec
  • Company: Université Laval

Citation (CITATION.cff)

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Raulier
    given-names: Bastian
    orcid: https://orcid.org/0000-0002-3901-2522
title: "HE60-PyMagister: A Python package for the control of HydroLight software."
version: 2.0.4
date-released: 2023-01-01

GitHub Events

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

Dependencies

setup.py pypi