Metadata-Version: 2.1
Name: rawls
Version: 0.0.2
Summary: RAW Light Simulation file reader/converter package
Home-page: https://github.com/prise-3d/rawls
Author: Jérôme BUISINE
Author-email: jerome.buisine@univ-littoral.fr
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: Pillow

RAW Light Simulation reader/converter package
=============================================

Installation
------------

```bash
pip install rawls
```

How to use ?
------------

To use, simply do :

```python
from rawls.classes.rawls import Rawls
path = 'images/example.rawls'
rawls_img = Rawls.fromfile(path)
rawls_img.to_png('output.png')
```

Modules
-------

This project contains modules.

- **converter** : *Converter functions in order to convert image into another*
- **merger** : *Merger functions which enables to merge `.rawls` image files*

All these modules will be enhanced during development of the package. Documentation is available [here](https://prise-3d.github.io/rawls/).

How to contribute
-----------------

Please refer to the [guidelines](CONTRIBUTING.md) file if you want to contribute!

## Contributors

* [jbuisine](https://github.com/jbuisine)

## License

[MIT](LICENSE)


