.. isocompy documentation master file, created by
   sphinx-quickstart on Mon Jan 30 16:14:50 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

isocompy's documentation!
====================================

This repository contains an open source Python library that focuses on user defined (such as meteorological, spatial, etc.) and isotopic composition variables analysis and generating the regression – statistical estimation models. 


Package information
====================

Name: Isocompy

version: 1.0.2

Author: Ashkan Hassanzadeh   

Email: ashkan.hassanzadeh@gmail.com

python: 3.*

License: agpl-3.0


Citation
=========

Hassanzadeh, A., Valdivielso, S., Vázquez-Suñé, E., Criollo, R., Corbella, M., 2023. An open source Python library for environmental isotopic modelling. Sci. Reports 2023 131 13, 1–19. https://doi.org/10.1038/s41598-023-29073-2


Installation
==================

pip can be used for the installation:

`pip install isocompy`

Alternatively, download the isocompy folder from the github repository and add it to lib folder in python path alongside other python libraries.

Jupyter Notebook
==================

There is a notebook in `isocompy's github repository <https://github.com/IDAEA-EVS/Isocompy>`_ that explains an example of implementing isocompy on spatial and isotopic data


.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   Home
   data_preparation.preprocess-class
   reg_model.model-class
   tools.evaluation-class
   tools.plots-class
   tools.session-class
   tools.stats-class
   LICENSE


search
=======

* :ref:`search`