Skip to main content

The skylight project GitHub top language GitHub license GitHub last-commit Build Status

vevoda-2022-teaser

This Python package implements three models that provide skylight information.

1. The Prague sky model

This model (proposed by Vévoda P. et al., 2022; original C++ code here) interpolates the skylight properties by using stored data for a range of parameters, and it does not include data for the angle of polarisation (this is calculated by using the analytical solution).

prague-sky-model

There are three available datasets that work with the Prague Sky Model, which can be downloaded form here:

2. Analytic sky model

This model (proposed by Wilkie A. et al., 2004; and Preetham A. J. et al., 1999) includes radiance and polarisation information.

analytic-sky-model

3. Uniform model

This model provides the same information for any sky conditions and viewing directions, and it could be used as a baseline model.

uniform-sky-model

Installation

You can easily install the package by using pip as:

pip install git+https://github.com/evgkanias/sky.git

Alternatively you need to clone the GitHub repository, navigate to the main directory of the project, install the dependencies and finally the package itself. Here is an example code that installs the package:

  1. Clone this repo.
mkdir ~/src
cd ~/src
git clone https://github.com/evgkanias/sky.git
cd sky
  1. Install the required libraries.
    1. using pip :

      pip install -r requirements.txt
      
    2. using conda :

      conda env create -f environment.yml
      conda activate sky-env
      
  2. Install the package.
    1. using pip :
      pip install .
      
    2. using conda :
      conda install .
      

Note that the pip project might be needed for the above installation.

Graphical User Interface (GUI)

If you prefer to use a graphical user interface for this package, there is a separate package that you can install and use. This is named the sky-gui and it allows for interactive exploration of the skylight properties for the different models. However, in this version, only the Prague Sky Model is supported.

gui-teaser

Report an issue

If you have any issues installing or using the package, you can report it here.

Author

The code is written by Evripidis Gkanias.

Credits

The original (C++) code for this model was written by Petr Vévoda et al. from Alexander Wilkie's group in Charles University, which was part of their wide spectral range sky radiance model.

Copyright

Copyright © 2022, Evripidis Gkanias; Institute of Perception, Action and Behaviour; School of Informatics; the University of Edinburgh.

Metadata

Release files for skylight 1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for skylight 1.1
File Size Uploaded Provenance
skylight-1.1.tar.gz 64.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for skylight 1.1
File Interpreter ABI Platform
skylight-1.1-py3-none-any.whl Python 3 none any Details

Total release size: 130.2 kB

Release files / skylight-1.1.tar.gz

Download URL skylight-1.1.tar.gz
Size 64.5 kB
Tags Source
SHA-256 checksum
How to use checksums
9e9649d9290748fd75968e06578de2118b0fe6055068d9ab33433f942e3a7ede
BLAKE2b-256 checksum
How to use checksums
f617c53531452e77f876f1bc74221a8cf02300e5902605a65284dc2f6dc0ee93
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Release files / skylight-1.1-py3-none-any.whl

Download URL skylight-1.1-py3-none-any.whl
Size 65.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
42a04a8ab392b97ec3ece442ab1c4c5c6aed8e8aa8862e1eaa50e3484f5f81f8
BLAKE2b-256 checksum
How to use checksums
e79f29597b0cacdecb6613fa6e7108f246be6d20b9439e919744e110c06589c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.9.20

Security for skylight 1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page