Optics raytracer
Project description
[//]: # ( @mainpage ) [](https://travis-ci.org/jmeyers314/batoid) [](https://codecov.io/gh/jmeyers314/batoid) [](https://batoid.readthedocs.io/en/latest/?badge=latest)
batoid
A c++ backed python optical raytracer.
Requirements
Batoid is known to work on MacOS and linux, using Python version 3.4+, and either the clang or gcc compiler with support for c++11.
Installation
This should be as simple as cloning the repo and running setup.py. One minor hiccup is that this repo includes submodules for pybind11 and eigen, so when cloning for the first time, a command similar to one of the following should be used:
` git clone --recurse-submodules git@github.com:jmeyers314/batoid.git `
or
` git clone --recurse-submodules https://github.com/jmeyers314/batoid.git `
Once the repo and the submodules have been cloned, then compile and install with
` python setup.py install `
or optionally
` python setup.py install --user `
Tests
To run the unit tests, from the batoid directory, first install the testing requirements:
` pip install -r test_requirements.txt `
And then run the tests using setup.py:
` python setup.py test `
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
](https://travis-ci.org/jmeyers314/batoid){kind=link}
](https://codecov.io/gh/jmeyers314/batoid){kind=link}