Skip to main content

Thin Python wrapper for the SCREEN3 point source dispersion model

Project description

screen3

Thin Python wrapper for the SCREEN3 point source dispersion model

CI workflow status Version on PyPI

pdoc API documentation: https://zmoon.github.io/screen3/screen3.html

Installation

Stable:

pip install screen3

Latest:

pip install git+https://github.com/zmoon/screen3

SCREEN3

The screen3 Python installation via pip does not include the SCREEN3 model itself. To download it (into ./src/), you can use (within Python):

import screen3
screen3.download()

or on the command line:

python -c "import screen3; screen3.download()"

Windows

On Windows, the above (download only) is sufficient to be able to use screen3, since EPA provides an executable compiled for Windows.

Non-Windows

On non-Windows platforms, the SCREEN3 model must be built from source. The screen3.build function, which requires patch and gfortran, can be used:

python -c "import screen3; screen3.build()"

or combined with the download:

python -c "import screen3; screen3.download(); screen3.build()"

Examples

To obtain the examples, git clone the repo, use Code > Download Zip (buttons), or use this DownGit link:
https://downgit.github.io/#/home?url=https://github.com/zmoon/screen3/tree/main/examples

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

screen3-0.1.1.tar.gz (10.4 kB view hashes)

Uploaded Source

Built Distribution

screen3-0.1.1-py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page