https://github.com/sdat2/sithom

A package for shared utility scripts.
https://github.com/sdat2/sithom

Last synced: 4 months ago
JSON representation

A package for shared utility scripts.

• Host: GitHub
• URL: https://github.com/sdat2/sithom
• Owner: sdat2
• License: mit
• Created: 2022-05-26T13:40:02.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-08-23T10:46:56.000Z (10 months ago)
• Last Synced: 2026-01-29T23:18:40.811Z (4 months ago)
• Language: Python
• Size: 155 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.txt
  • License: LICENSE
  • Citation: CITATION.cff

Awesome Lists containing this project

README

          
# sithom README

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![Python package](https://github.com/sdat2/sithom/actions/workflows/python-package.yml/badge.svg)](https://github.com/sdat2/sithom/actions/workflows/python-package.yml)[![Documentation Status](https://readthedocs.org/projects/sithom/badge/?version=latest)](https://sithom.readthedocs.io/en/latest/?badge=latest)[![PyPI version](https://badge.fury.io/py/sithom.svg)](https://badge.fury.io/py/sithom)[![DOI](https://zenodo.org/badge/496635214.svg)](https://zenodo.org/badge/latestdoi/496635214)

## Description

A package for shared utility scripts that I use in my research projects.

I realised I was copying functionality from project to project. So instead, here it is.

## Install using pip

```bash

pip install sithom

```

## Install using conda

```bash

conda install -c conda-forge sithom

```

## Package structure

```text

├── CHANGELOG.txt      <- List of main changes at each new package version.

├── CITATION.cff       <- File to allow you to easily cite this repository.

├── LICENSE            <- MIT Open software license.

├── Makefile           <- Makefile with commands.

├── pytest.ini         <- Enable doctest unit-tests.

├── README.md          <- The top-level README for developers using this project.

├── setup.py           <- Python setup file for pip install.

|

├── sithom             <- Package folder.

|   |

│   ├── __init__.py    <- Init file.

│   ├── _version.py    <- Key package information.

│   ├── curve.py       <- Curve fitting w. uncertainty propogation.

│   ├── io.py          <- Input output functions (json).

│   ├── misc.py        <- Miscellanious utilities.

│   ├── place.py       <- Place objects.

│   ├── plot.py        <- Plot utilties.

│   ├── time.py        <- Time utilties.

│   ├── unc.py         <- Uncertainties utilties.

│   └── xr.py          <- Xarray utilties.

|

└── tests              <- Test folder.

```

## Requirements

 - Python 3.8+

 - `matplotlib`

 - `seaborn`

 - `cmocean`

 - `xarray`

 - `uncertainties`

 - `jupyterthemes`