esox 0.1.1

Library for NISECI and HFBI calc
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

# esox
[![Latest version](https://img.shields.io/crates/v/esox.svg)](https://crates.io/crates/esox)

## Library for NISECI and HFBI calc

## Table of Contents

+ [What is this thing?](#witt)
+ [Input templates](#input_templates)
+ [Locale](#locale)
+ [References](#references)

## What is this thing? <a name = "witt"></a>

This is a library for calculating the NISECI and/or HFBI index for a dataset.

## Input templates <a name = "input_templates"></a>

You can find templates for the input files in the `templates` folder.

## Locale <a name = "locale"></a>

Since this library is built with knowing that Excel uses some specific separators with the Italian locale, it supports two formats for input/output.

The format differences are:
- Italian:
  - Input expects `;` as csv field delimiter, and `,` can be used as float decimal delimiter
  - Output uses `;` as csv field delimiter, and floats are printed with `,` as decimal delimiter
- International:
  - Input expectes `,` as csv field delimiter, and `.` as float decimal delimiter
  - Output uses `,` as csv field delimiter, and floats are printed with `.` as decimal delimiter

## References <a name = "references"></a>

- [ISPRA - Nuove indice dello stato ecologico delle comunità ittiche - NISECI](https://www.isprambiente.gov.it/it/pubblicazioni/manuali-e-linee-guida/nuovo-indice-dello-stato-ecologico-delle-comunita-ittiche-niseci)
- [ISPRA - Manuale per la classificazione dell'Elemento di Qualità Biologica "Fauna Ittica" nelle lagune costiere italiane - HFBI](https://www.isprambiente.gov.it/it/pubblicazioni/manuali-e-linee-guida/manuale-per-la-classificazione-dell-elemento-di-qualita-biologica-fauna-ittica-nelle-lagune-costiere-italiane)