Skip to main content

Odak (pronounced O-dac) is the fundamental Python libraryfor scientific computing in optical sciences.Odak includes modules for geometric raytracing and wave optics.

Project description

# Odak [![DOI](https://zenodo.org/badge/3987171.svg)](https://zenodo.org/badge/latestdoi/3987171)

Odak (pronounced “O-dac”) is the fundamental library for scientific computing in optical sciences. Odak includes modules for geometric [3D raytracing](odak/raytracing/), [Jones calculus](odak/jones), [beam propagation and wave optics](odak/wave) among with [a set of tools](odak/tools) to ease your pain in [measurement](odak/measurement), [exporting/importing CAD](odak/tools/asset.py), and [visualization](odak/visualize) during a design process. We have generated a set of recipes that goes well with machine learning approaches compatible with torch learning framework, which can also be found [here](odak/learn). We have created a bunch of [test scripts](test/) for inspiring the way you use odak and helping your design process. For computationally expensive tasks, we have created a [distribution system](odak/manager) to process tasks in parallel across multiple computing resources within the same network. Odak can either run using CPUs or can switch to [NVIDIA GPUs](odak/__init__.py#L8) automatically.

## Getting Started

### Installing Odak can be installed using [pip](https://pypi.org/project/pip):

`bash pip3 install git+https://github.com/kunguz/odak `

or:

`bash pip3 install odak `

### Usage It is easy as in this recorded session. Import it to your code and start designing your next in Optics!

![alt tag](example.gif)

## Citing If you use Odak in a research project leading to a publication, please acknowledge this fact by using our [bibtex citation entry generated by Zenodo](https://zenodo.org/record/5035579).

## Contributing Perhaps the best way is checking the issues section as a starter. If you have a specific point in mind and can’t find it in the issues section, starting an issue accordingly is an another good starting point. If you think you have bigger plans in mind, here is my email kaanaksit at kaanaksit dot com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for odak, version 0.1.8
Filename, size File type Python version Upload date Hashes
Filename, size odak-0.1.8-py3-none-any.whl (87.3 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size odak-0.1.8.tar.gz (75.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page