Metadata-Version: 2.4
Name: tempcf
Version: 0.11.3
Summary: A toolbox for flagging and cleaning ground temperature data
Author: Ryan Parker, Alex Gao
Author-email: Nick Brown <nick.brown@carleton.ca>
Project-URL: Homepage, https://gitlab.com/permafrostnet/tempcf
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: tsp[full]>=1.12.0
Requires-Dist: pfit
Requires-Dist: pandas==2.3.3
Requires-Dist: pillow
Requires-Dist: scipy
Requires-Dist: pandastable
Requires-Dist: mpl_interactions
Dynamic: license-file

# TEMPCF: Cleaning and Filtering for Ground Temperature Data

This package provides a graphical user interface for viewing, flagging, and cleaning ground temperature data for permafrost applications. It is designed to work with a variety of different input data types including data loggers, and databases. It uses read / write functionality provided by the [teaspoon](https://gitlab.com/permafrostnet/teaspoon) package ([Brown, 2022](https://joss.theoj.org/papers/10.21105/joss.04704)).

For a full description of the package, including some examples, please see the [documentation pages](https://permafrostnet.gitlab.io/tempcf/).


# How to get tempcf
There are a few ways to get tempcf running on your computer.

## Install from pip

You can install tempcf with pip:
```cmd
pip install tempcf
```

Then you can run it from the command line with:
```cmd
tempcf
```

### GSC plugin

The GSC plugin is not on PyPI. Install it from GitHub alongside tempcf:
```cmd
pip install git+https://github.com/gsc-permafrost/tempcf-gsc.git
```

## Running pre-compiled executables

As an alternative to command-line installation, its possible to download the latest files from the [Releases](https://gitlab.com/permafrostnet/permafrost-tempcf/-/releases) page of the GitLab repository. This requires no coding experience whatsoever, but only works on Windows and Linux at the moment. These also won't be the most up-to-date versions.

If you are familiar with python and would rather run tempf from the source code, follow the instructions below. This is the preferred option if you intend to contribute, or if you want to make any modifications.

## Install from source

### Step 1: Download the files

```
git clone https://gitlab.com/permafrostnet/permafrost-tempcf
```

### Step 2: Create a virtual environment

This makes sure that the python packages that get installed don't conflict with other python packages you might have installed.
On Mac or Linux, make sure to replace '\' with '/' in the last line.

```cmd
cd permafrost-tempcf
python -m venv env
.\env\Scripts\activate 
```

### Step 3: Install tempcf

These commands will install the required dependencies, and launch tempcf

```cmd
python setup.py install
cd tempcf
python main.py
```


