Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/quant-aq/py-smps

Python library for the analysis and visualization of data from a Scanning Mobility Particle Sizer (SMPS) and other similar instruments (SEMS, OPC's).
https://github.com/quant-aq/py-smps

aerosol atmospheric-science chemistry mit science

Last synced: about 2 months ago
JSON representation

Python library for the analysis and visualization of data from a Scanning Mobility Particle Sizer (SMPS) and other similar instruments (SEMS, OPC's).

Host: GitHub
URL: https://github.com/quant-aq/py-smps
Owner: quant-aq
License: mit
Created: 2017-02-19T19:40:37.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-05-08T21:43:11.000Z (about 2 months ago)
Last Synced: 2024-05-09T06:01:37.048Z (about 2 months ago)
Topics: aerosol, atmospheric-science, chemistry, mit, science
Language: Python
Homepage: https://quant-aq.github.io/py-smps/
Size: 15.9 MB
Stars: 29
Watchers: 6
Forks: 13
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

open-sustainable-technology - py-smps - Python package for analyzing and visualizing size-resolved aerosol data from a variety of aerosol sizing instruments. (Atmosphere / Atmospheric Chemistry and Aerosol)
awesome-air-quality - py-smps - _Python library for the analysis and visualization of data from a Scanning Mobility Particle Sizer (SMPS) and other similar instruments (SEMS, OPC's)._ (Software Libraries)

README

[![PyPI version](https://badge.fury.io/py/py-smps.svg)](https://badge.fury.io/py/py-smps)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Coverage Status](https://coveralls.io/repos/github/dhhagan/py-smps/badge.svg?branch=master)](https://coveralls.io/github/dhhagan/py-smps?branch=master)
[![ci.tests](https://github.com/quant-aq/py-smps/actions/workflows/test-and-report.yml/badge.svg)](https://github.com/quant-aq/py-smps/actions/workflows/test-and-report.yml)

# py-smps

py-smps is a Python data analysis library built for analyzing size-resolved aerosol data from a variety of aerosol sizing instruments (e.g., Scanning Mobility Particle Sizer, Optical Particle Counters).

**NOTE: As of `v1.2.0`, the library is compatible with Apple silicone (M1, M2 chips).**

# Installation

Official releases of `py-smps` can be installed from [PyPI](https://pypi.org/project/py-smps/):

$ pip install py-smps [--upgrade]

If you'd like the latest pre-release:

$ pip install py-smps --pre [--upgrade]

To install the edge release directly from GitHub:

pip install git+https://github.com/quant-aq/py-smps.git

# Dependencies

## Supported Python versions
- Python 3.8+

## Mandatory Dependencies

The full list of dependencies can be found in the [`pyproject.toml`](pyproject.toml) file.

# Development

## Testing

Tests can be run by issuing the following command from within the main repo:

```sh
$ poetry run pytest -s tests/ --ignore=tests/datafiles
```

## Contributing to Development

We welcome all contributions from the community in the form of issues reporting, feature requests, bug fixes, etc.

If there is a feature you would like to see or a bug you would like to report, please open an issue. We will try to get to things as promptly as possible. Otherwise, feel free to send PR's!

### Contributors

# Documentation

Documentation is available [here](https://quant-aq.github.io/py-smps/). To build locally, you must first install [pandoc](https://pandoc.org/). Docs are built using Sphinx and can be built locally by doing the following:

```sh
# Activate the virtualenv
$ poetry shell

# Build the docs
$ cd docs/
$ make clean
$ make html
$ cd ..
```

Then, you can navigate to your local directory at `docs/build/html/` and open up the `index.html` file in your preferred browser window.