Data

Tools

Indexes

Applications

Experiments

Open Source Science

sloppy

A fast ray tracer for cavity design in python

https://github.com/lksplm/sloppy

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 (12.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

A fast ray tracer for cavity design in python

Basic Info
  • Host: GitHub
  • Owner: lksplm
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: master
  • Size: 28.8 MB
Statistics
  • Stars: 1
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created 11 months ago · Last pushed 9 months ago
Metadata Files
Readme Changelog License Citation Authors

README.rst 

.. image:: logo.svg
  :width: 800
  :alt: Logo

======
Simon Lab Optics Package in PYthon
======

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/lksplm/sloppy/HEAD?urlpath=%2Fdoc%2Ftree%2Findex.ipynb)

The Simon Lab Optics Package in PYthon is a collection of computational methods for the design of optical systems, especially cavities.

It strides to provide a unified interface to perform
- ABCD matrix formalism
- Raytracing
- Perturbation theory on top of paraxial eigenmodes


Description
===========

So far, the package includes Raytracing of Mirrors and Lenses, 


Installation
============

It's recommended use a conda environment to install the required packages::
    conda create -n sloppy 
    
If you want to use this environment as a kernel in your Jupyter Lab, add the kernel as described in this link ``_.
    
Apart from the standard packages (numpy, matplotlib, ...), the only package that is a little tricky is `K3D-jupyter `_
that is used to eable 3D visualisation in Jupyter Lab. It can be installed via::
    conda install -c conda-forge k3d

To enable the extension for Jupyter Lab run::
    jupyter labextension install @jupyter-widgets/jupyterlab-manager
    jupyter labextension install k3d
    
After cloning using git, install the package in the development version (only one supported now) via::
    python setup.py develop

You can then generate the documentation (managed via sphinx) as::
    python setup.py docs
    
Note
====

This project has been set up using PyScaffold 3.2.3. For details and usage
information on PyScaffold see https://pyscaffold.org/.

Owner

  • Login: lksplm
  • Kind: user

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: sloppy
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Lukas
    family-names: Palm
    email: lukasp@stanford.edu
    affiliation: 'Stanford University, University of Chicago'
    orcid: 'https://orcid.org/0000-0003-1383-4293'
repository-code: 'https://github.com/lksplm/sloppy/'
abstract: >-
  The Simon Lab Optics Package in PYthon is a collection of
  computational methods for the design of optical systems,
  especially cavities.

  It' s a framework coupling ABCD matrix formalism,
  raytracing and perturbation theory for semiclassical and
  quantized analysis of novel cavity geometries and their
  mode spectra.
license: MIT

GitHub Events

Total
  • Watch event: 1
  • Push event: 7
  • Create event: 2
Last Year
  • Watch event: 1
  • Push event: 7
  • Create event: 2