Metadata-Version: 2.4
Name: seabirdscientific
Version: 3.0.0
Summary: Sea-Bird Scientific Community Toolkit
Author-email: Sea-Bird Scientific <techsupport@seabird.com>, Ryan Anderson <randerson@seabird.com>, Lukas Christensen <lchristensen@seabird.com>, Dane Lucas <dlucas@seabird.com>, Eric Rehm <erehm@seabird.com>, Bruce Rhoades <brhoades@seabird.com>, Jesse Templin <jtemplin@seabird.com>
License-Expression: MIT
Project-URL: Homepage, https://www.seabird.com/software
Project-URL: Repository, https://github.com/Sea-BirdScientific/seabirdscientific
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: gsw>=3.6.18
Requires-Dist: numpy>=2.2.0
Requires-Dist: pandas>=2.3.0
Requires-Dist: scipy>=1.15.0
Requires-Dist: seawater>=3.3.3
Requires-Dist: xarray>=2024.10.0
Provides-Extra: docs
Requires-Dist: sbsfuro>=0.1.0; extra == "docs"
Requires-Dist: sphinx>=8.2.0; extra == "docs"
Requires-Dist: sphinx-mdinclude>=0.6.2; extra == "docs"
Provides-Extra: notebooks
Requires-Dist: ipykernel>=6.30.0; extra == "notebooks"
Requires-Dist: ipython>=8.10.0; extra == "notebooks"
Requires-Dist: nbconvert[webpdf]>=7.17.0; extra == "notebooks"
Requires-Dist: nbformat>=5.11.0; extra == "notebooks"
Requires-Dist: notebook>=7.6.3; extra == "notebooks"
Provides-Extra: plots
Requires-Dist: kaleido>=1.0.0; extra == "plots"
Requires-Dist: matplotlib>=3.10.0; extra == "plots"
Requires-Dist: plotly>=6.0.0; extra == "plots"
Dynamic: license-file

# seabirdscientific

This is the repository for the Sea-Bird Scientific (SBS) Community Toolkit. It is a collection of:

- Python code to process and visualize data collected with SBS instruments (src/seabirdscientific).
- Example SBS instrument data (notebooks/example_data and tests/resources/test-data).
- [Jupyter](https://jupyter.org/) notebooks that demonstrate converting raw data from SBS instruments and processing it with the toolkit. The `processing.ipynb` notebook serves as documentation for the formulas used in the toolkit and [Fathom](https://www.seabird.com/software), and is also available as a [PDF](https://github.com/Sea-BirdScientific/seabirdscientific/blob/main/notebooks/processing.pdf).

## Migration Guide: v2 to v3
There are many improvements and some breaking changes in version 3. Review the migrations guide to what's new and update your existing scripts as needed.  
<https://sea-birdscientific.github.io/seabirdscientific/migration_guide_v2_v3.html>

## Documentation
<https://sea-birdscientific.github.io/seabirdscientific/>  

## Installation
The toolkit requires [Python](https://www.python.org) 3.11 or greater.  

### Windows:

``` bash
py -m pip install seabirdscientific
```

### Linux/macOS:

``` bash
python3 -m pip install seabirdscientific
```

## Contributing to the Toolkit

If you have code that you would like to contribute to the SBS community toolkit please see the [Toolkit Contribution Guidelines](https://github.com/Sea-BirdScientific/seabirdscientific/blob/main/CONTRIBUTING.md).

If you have a question, please submit it using this [question form](https://github.com/Sea-BirdScientific/seabirdscientific/issues/new?template=question.md).

If you would like to request a new feature, please submit a [feature request form](https://github.com/Sea-BirdScientific/seabirdscientific/issues/new?template=feature_request.md).

If you find a bug, please submit a [bug report](https://github.com/Sea-BirdScientific/seabirdscientific/issues/new?template=bug_report.md).

If you have data to share for inclusion in the toolkit, or for anything else, please contact [SBS customer support](https://www.seabird.com/support)
