Metadata-Version: 2.4
Name: snowmicropyn
Version: 1.4.0
Summary: A Python package to read, export and post process data (*.pnt files) recorded by SnowMicroPen, a snow penetration probe for scientific applications developed at SLF.
Home-page: https://github.com/slf-dot-ch/snowmicropyn
Author: WSL Institute for Snow and Avalanche Research SLF
Author-email: snowmicropen@slf.ch
License: GPL
Keywords: SLF,SnowMicroPen,Snow Micro Pen,SMP,Snow,Science,Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
Requires-Python: >=3.10
License-File: LICENSE.txt
Requires-Dist: matplotlib>=3.10
Requires-Dist: numpy
Requires-Dist: pandas>=0.22
Requires-Dist: pytz
Requires-Dist: scipy>=1
Requires-Dist: scikit-learn
Requires-Dist: PyQt5
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

snowmicropyn
============

A Python package to read, export and post process data (``*.pnt`` files)
recorded by SnowMicroPen_, a snow penetration probe for scientifc applications
developed at SLF_.

The software is open source and released under `GPL`_. Contributions are
welcome.

Installing
----------

Use a virtual environment (recommended), then install with either
``pip`` or ``uv``.

Using ``pip``

.. code-block:: console

    python -m venv .venv
    source .venv/bin/activate
    python -m pip install snowmicropyn

To upgrade in the same environment:

.. code-block:: console

    python -m pip install --upgrade snowmicropyn

Using ``uv``

.. code-block:: console

    uv venv
    uv pip install snowmicropyn

To upgrade in the same environment:

.. code-block:: console

    uv pip install --upgrade snowmicropyn

Editable install (development)

.. code-block:: console

    git clone https://github.com/slf-dot-ch/snowmicropyn.git
    cd snowmicropyn
    python -m venv .venv
    source .venv/bin/activate
    python -m pip install -e .

A Simple Example
----------------

.. code-block:: python

    from snowmicropyn import Profile

    p = Profile.load('/examples/profiles/S37M0876.ini')

    ts = p.timestamp
    coords = p.coordinates
    samples = p.samples  # It's a pandas dataframe

Documentation
-------------

The project's documentation_ can be studied on *Read the Docs*.

Contact
-------

To get in touch, please write to snowmicropen@slf.ch.


.. _SLF: https://www.slf.ch
.. _SnowMicroPen: https://www.slf.ch/en/about-the-slf/instrumented-field-sites-and-laboratories/snow-instruments/snowmicropenr/
.. _GPL: https://www.gnu.org/licenses/gpl-3.0.en.html
.. _documentation: https://snowmicropyn.readthedocs.io/
