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 1 month 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 (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T11:24:57.000Z (7 months ago)
- Last Synced: 2024-10-29T19:52:30.243Z (6 months ago)
- Topics: aerosol, atmospheric-science, chemistry, mit, science
- Language: Python
- Homepage: https://quant-aq.github.io/py-smps/
- Size: 16 MB
- Stars: 32
- Watchers: 6
- Forks: 13
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- 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)
- 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)
README
[](https://badge.fury.io/py/py-smps)
[](https://opensource.org/licenses/MIT)
[](https://coveralls.io/github/dhhagan/py-smps?branch=master)
[](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.