raytools


Nameraytools JSON
Version 0.1.5 PyPI version JSON
download
home_pagehttps://github.com/stephanwaz/raytools
Summaryworking with hdr images, numpy and coordinate transformations for lighting simulation
upload_time2023-11-17 14:12:37
maintainer
docs_urlNone
authorStephen Wasilewski
requires_python>=3.6.8
licenseMozilla Public License 2.0 (MPL 2.0)
keywords raytools
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ====================
raytools (0.1.5)
====================

.. image:: https://img.shields.io/pypi/v/raytools?style=flat-square
    :target: https://pypi.org/project/raytools
    :alt: PyPI

.. image:: https://img.shields.io/pypi/l/raytools?style=flat-square
    :target: https://www.mozilla.org/en-US/MPL/2.0/
    :alt: PyPI - License

.. image:: https://img.shields.io/readthedocs/raytools/stable?style=flat-square
    :target: https://raytools.readthedocs.io/en/stable/
    :alt: Read the Docs (version)

.. image:: https://img.shields.io/coveralls/github/stephanwaz/raytools?style=flat-square
    :target: https://coveralls.io/github/stephanwaz/raytools
    :alt: Coveralls github

working with hdr images, numpy and coordinate transformations for lighting simulation (basic libraries for raytraverse).
Installs with a command line tool for calculating daylight metrics from angular fisheye images (similar to evalglare).

* Free software: Mozilla Public License 2.0 (MPL 2.0)
* Documentation: https://raytools.readthedocs.io/en/latest/.


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

Raytools requires MacOS or Linux operating system with python >=3.7. For
windows you can consider using docker (https://www.docker.com/products/docker-desktop/ ).
raytools can be installed in the python:3.9 container.

The easiest way to install raytools is with pip::

    pip install --upgrade pip
    pip install raytools

or if you have cloned this repository::

    cd path/to/this/file
    pip install .

Note: raytools depends on a small subset of Radiance executables
(rcalc, vwrays, getinfo, pvalue). If these are not available in the $PATH at
the time of installation, then those precompiled (macos or linux) binaries will
be installed to the same bin/ as the current python (and raytools), which could be
in a virtualenv. This avoids overriding the existing install of these programs,
but it does require that you make sure that the enviroment at installation is the same as
when using raytools.

Getting Started
---------------
After installation, the raytools executable should be available from the command line.
See "raytools --help" and "raytools metric --help" for usage.

=======
History
=======

0.1.0 (2023-01-06)
------------------

* First release on PyPI.
* basic library and image metric CLI split off from raytraverse

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/stephanwaz/raytools",
    "name": "raytools",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6.8",
    "maintainer_email": "",
    "keywords": "raytools",
    "author": "Stephen Wasilewski",
    "author_email": "stephanwaz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c3/70/9c3438573a3ab0e59bdfb3aef0f58df067f274aff03cf11eaaa5657c3869/raytools-0.1.5.tar.gz",
    "platform": null,
    "description": "====================\nraytools (0.1.5)\n====================\n\n.. image:: https://img.shields.io/pypi/v/raytools?style=flat-square\n    :target: https://pypi.org/project/raytools\n    :alt: PyPI\n\n.. image:: https://img.shields.io/pypi/l/raytools?style=flat-square\n    :target: https://www.mozilla.org/en-US/MPL/2.0/\n    :alt: PyPI - License\n\n.. image:: https://img.shields.io/readthedocs/raytools/stable?style=flat-square\n    :target: https://raytools.readthedocs.io/en/stable/\n    :alt: Read the Docs (version)\n\n.. image:: https://img.shields.io/coveralls/github/stephanwaz/raytools?style=flat-square\n    :target: https://coveralls.io/github/stephanwaz/raytools\n    :alt: Coveralls github\n\nworking with hdr images, numpy and coordinate transformations for lighting simulation (basic libraries for raytraverse).\nInstalls with a command line tool for calculating daylight metrics from angular fisheye images (similar to evalglare).\n\n* Free software: Mozilla Public License 2.0 (MPL 2.0)\n* Documentation: https://raytools.readthedocs.io/en/latest/.\n\n\nInstallation\n------------\n\nRaytools requires MacOS or Linux operating system with python >=3.7. For\nwindows you can consider using docker (https://www.docker.com/products/docker-desktop/ ).\nraytools can be installed in the python:3.9 container.\n\nThe easiest way to install raytools is with pip::\n\n    pip install --upgrade pip\n    pip install raytools\n\nor if you have cloned this repository::\n\n    cd path/to/this/file\n    pip install .\n\nNote: raytools depends on a small subset of Radiance executables\n(rcalc, vwrays, getinfo, pvalue). If these are not available in the $PATH at\nthe time of installation, then those precompiled (macos or linux) binaries will\nbe installed to the same bin/ as the current python (and raytools), which could be\nin a virtualenv. This avoids overriding the existing install of these programs,\nbut it does require that you make sure that the enviroment at installation is the same as\nwhen using raytools.\n\nGetting Started\n---------------\nAfter installation, the raytools executable should be available from the command line.\nSee \"raytools --help\" and \"raytools metric --help\" for usage.\n\n=======\nHistory\n=======\n\n0.1.0 (2023-01-06)\n------------------\n\n* First release on PyPI.\n* basic library and image metric CLI split off from raytraverse\n",
    "bugtrack_url": null,
    "license": "Mozilla Public License 2.0 (MPL 2.0)",
    "summary": "working with hdr images, numpy and coordinate transformations for lighting simulation",
    "version": "0.1.5",
    "project_urls": {
        "Homepage": "https://github.com/stephanwaz/raytools"
    },
    "split_keywords": [
        "raytools"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c3709c3438573a3ab0e59bdfb3aef0f58df067f274aff03cf11eaaa5657c3869",
                "md5": "1e3671e0075d4e80f38f22736eb8f8de",
                "sha256": "47f5068d6dc2339f5e3ee22e826f38518f1a8d4981b277f2e73220a629431989"
            },
            "downloads": -1,
            "filename": "raytools-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "1e3671e0075d4e80f38f22736eb8f8de",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6.8",
            "size": 1310404,
            "upload_time": "2023-11-17T14:12:37",
            "upload_time_iso_8601": "2023-11-17T14:12:37.734029Z",
            "url": "https://files.pythonhosted.org/packages/c3/70/9c3438573a3ab0e59bdfb3aef0f58df067f274aff03cf11eaaa5657c3869/raytools-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-11-17 14:12:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "stephanwaz",
    "github_project": "raytools",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "raytools"
}
        
Elapsed time: 0.14166s