https://github.com/zmoon/screen3

Thin Python wrapper for the SCREEN3 point source dispersion model
https://github.com/zmoon/screen3

Last synced: about 1 year ago
JSON representation

Thin Python wrapper for the SCREEN3 point source dispersion model

• Host: GitHub
• URL: https://github.com/zmoon/screen3
• Owner: zmoon
• License: mit
• Created: 2021-04-08T18:00:15.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T15:52:09.000Z (over 1 year ago)
• Last Synced: 2025-03-27T21:46:38.782Z (about 1 year ago)
• Language: Python
• Size: 165 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# screen3

*Thin Python wrapper for the* [SCREEN3](https://www.epa.gov/scram/air-quality-dispersion-modeling-screening-models#screen3) *point source dispersion model*

[![CI workflow status](https://github.com/zmoon/screen3/actions/workflows/ci.yml/badge.svg)](https://github.com/zmoon/screen3/actions/workflows/ci.yml)

[![Version on PyPI](https://img.shields.io/pypi/v/screen3.svg)](https://pypi.org/project/screen3/)

[![Project Status: Inactive – The project has reached a stable, usable state but is no longer being actively developed; support/maintenance will be provided as time allows.](https://www.repostatus.org/badges/latest/inactive.svg)](https://www.repostatus.org/#inactive)

[pdoc](https://pdoc.dev/) API documentation: 

## Installation

Stable:

```

pip install screen3

```

Latest:

```

pip install https://github.com/zmoon/screen3/archive/main.zip

```

### SCREEN3

The `screen3` Python installation via `pip` does not include the SCREEN3 model itself.

To download it (into `./src/`), you can use (within Python):

```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](https://github.com/MinhasKamal/DownGit) link: