Metadata-Version: 2.4
Name: specmodels
Version: 0.1.1
Summary: A module to plot, fit, or simulate spectral reflectance data.
License-Expression: BSD-3-Clause-Clear
License-File: LICENSE_CODE
License-File: LICENSE_DOCS_MEDIA
Author: cxlfeller
Author-email: cxlfeller@gmx.com
Maintainer: cxlfeller
Maintainer-email: cxlfeller@gmx.com
Requires-Python: >=3.14.0
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: ipywidgets (>=8.1.8,<9.0.0)
Requires-Dist: matplotlib (>=3.10.8,<4.0.0)
Requires-Dist: numdifftools (>=0.9.42,<0.10.0)
Requires-Dist: numpy (>=2.3.5,<3.0.0)
Requires-Dist: pandas (>=3.0.2,<4.0.0)
Requires-Dist: scikit-learn (>=1.8.0,<2.0.0)
Requires-Dist: scipy (>=1.16.3,<2.0.0)
Description-Content-Type: text/markdown

# Welcome to the Specmodels package
[![][badge_release]](https://codeberg.org/cxlfeller/specmodels/releases) [![][badge_docs]](https://cxlfeller.codeberg.page/specmodels/index.html)

![][badge_pipeline] ![][badge_pylint]

[![][badge_license_code]](LICENSE_CODE)[![][badge_license_doc]](LICENSE_DOC)

## Carry home message

This python package was designed to read, plot and fit spectral data, in particular, reflectance
spectra obtained from particulate media. Several methods are implemented to visualize, and
consider specific features (e.g. an absorption band) of a spectrum.
Currently, this package also contains straightforward methods to fit such features with a gaussian
or a exponential modified gaussian function.

The documentation for this module is available [here](https://cxlfeller.codeberg.page/specmodels/index.html).

## Installation notes
Users can retrieve this package through pypi or a pip+git call.
```bash
$> pip install git+https://codeberg.org/cxlfeller/specmodels/main/
```
Beyond the example notebook available in the documentation, the other notebooks available in the
'examples' folder can be of further interest to the users.

People interested to contribute to the project should contact the authors/maintainers of the
package and have a glance to [contribute notes](CONTRIBUTE.md).


### License.
This project documentation and media are under a CC-BY-SA 4.0 license, and the source code
and scripts are provided under a [BSD 3-Clause Clear License](https://choosealicense.com/licenses/bsd-3-clause-clear/).


[badge_pipeline]: https://codeberg.org/cxlfeller/specmodels/actions/workflows/Pipeline.yaml/badge.svg?branch=main
[badge_release]: https://cxlfeller.codeberg.page/specmodels/_images/release.svg
[badge_docs]: https://cxlfeller.codeberg.page/specmodels/_images/documentation.svg
[badge_license_code]: https://cxlfeller.codeberg.page/specmodels/_images/license_code.svg
[badge_license_doc]: https://cxlfeller.codeberg.page/specmodels/_images/license_doc.svg
[badge_pylint]: https://cxlfeller.codeberg.page/specmodels/_images/pylint.svg
[badge_mypy]: https://cxlfeller.codeberg.page/specmodels/_images/mypy.svg

