semvec/pypi-packages huggingface dataset:
batoid 0.8.0
Optics raytracer
Requires Python: >=3.9

.. image:: https://github.com/jmeyers314/batoid/workflows/batoid%20CI/badge.svg
        :target: https://github.com/jmeyers314/batoid/workflows/batoid%20CI/badge.svg
.. image:: https://codecov.io/gh/jmeyers314/batoid/branch/master/graph/badge.svg
        :target: https://codecov.io/gh/jmeyers314/batoid


batoid
======

A c++ backed python optical raytracer.

docs
====
https://jmeyers314.github.io/batoid/overview.html


Requirements
============

Batoid is known to work on MacOS and linux, using Python version 3.9+, and
either the clang or gcc compiler with support for c++14.

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

PyPI
----

Released versions of batoid are available on pypi as both wheels and source
distributions.  To compile from source, you will need a c++14 compiler available and
placed such that that setup.py can find it.  This should hopefully be the case on most
*nix systems, in which case, the following ought to work::

    pip install batoid

Github
------

If PyPI doesn't work, then you can try cloning the source from github and
running setup.py.  Clone the repo with either ::

    git clone git@github.com:jmeyers314/batoid.git

or ::

    git clone https://github.com/jmeyers314/batoid.git

Once the repo has been cloned, then compile and install with ::

    pip install .

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 pytest ::

    pytest
mazing 0.1
Module to generate and interacte with mazes written in C for fast performance.
Requires Python: >=3.10

# Mazing

Python module in C to generate labyrinthes blazingly fast.

## USAGE

### Build

To build this application use make.
```bash
make
```

### CLI

CLI tool is made for presentation purposes, so it does not provide complete interface. Nevertheless you can generate and print maze with following template.
```bash
./genlab [seed] [height] [width] [x-start] [y-start] [x-exit] [y-exit]
```

### Tests

Run tests using pytest:

```bash
pytest
```

### Locally built Python module

Makefile will install python module into python venv, if none was found it will try to install it system-wide. In this case, to test your python build you will need to include compiled module into your PYTHONPATH environment variable.

```bash
export PYTHONPATH="${PWD}/build/lib.<os>-<arch>-cpython-<python_version>:${PYTHONPATH}"
```

## Dependencies

Build:

* clang
* Makefile
* python >= 3.10
    - build
    - setuptools