leeebo/esp-gsl

readme

## Overview

The component is a wrapper of GNU Scientific Library (GSL) for ESP SoCs (ESP32/ESP32-S3...), users can easily use it under ESP-IDF build system.

The GNU Scientific Library (GSL) is a numerical library for C and C++ programmers. It is free software under the *GNU General Public License*.

The library provides a wide range of mathematical routines such as random number generators, special functions and least-squares fitting. There are over 1000 functions in total with an extensive test suite.

Unlike the licenses of proprietary numerical libraries the license of GSL does not restrict scientific cooperation. It allows you to share your programs freely with others.

## License Warning

**The esp-gsl API implementation is licensed under GPLv3, you can link the lib for personally test, but you Must replace with other implementation (eg. from BSD Math lib) when distribute software binary or products.**

## How to use

### Add component from esp-registry to your project

You can use the component manager command `add-dependency` to add the `esp-gsl` to your project's dependency, during the `CMake` step the component will be downloaded automatically

```
idf.py add-dependency "leeebo/esp-gsl=*"
```

### Add component from git repository to your project

To add esp-gsl to your project from git repository, create an idf_component.yml file with the following contents and place it in the component's folder that depends on esp-gsl (for example, in the main folder of your project, since main is a special component in the esp-idf build system). The component will be downloaded automatically during the CMake processing step.

```
dependencies:
  esp-gsl:
    git: https://github.com/leeebo/esp-gsl.git
    version: "*"
```

> mirror repository: https://gitee.com/qljz/esp-gsl

### Download example from esp-registry

Please use the component manager command `create-project-from-example` to create the project from example template

```
idf.py create-project-from-example "leeebo/esp-gsl=*:test_project"
```

### Download example from git repository

You can also clone the git repository,and run `example/test_project` in the `esp-gsl/example/test_project` directory. Or you can also copy `example/test_project` to anywhere to run.

Then the example will download `esp-dsl` from the github repository automatically during `CMake`.

changelog

# ChangeLog

## v0.0.6 - 2023-07-02

* Build check in github actions
* Rename LICENCE file

## v0.0.5 - 2023-06-20

* Release to esp-registry

## v0.0.4 - 2023-03-04

* ADD GPLv3 LICENSE WARNING !!!

## v0.0.3 - 2023-03-03

### Bug Fixes:

* Fix readme

## v0.0.2 - 2023-03-03

### Bug Fixes:

* Fix library link failed

## v0.0.1 - 2023-03-02

* init version

                                        
                                        # Test Example

## How to use example

Follow detailed instructions provided specifically for this example. 

Select the instructions depending on Espressif chip installed on your development board:

- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)
- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)


## Example folder contents

The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main).

ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both). 

Below is short explanation of remaining files in the project folder.

```
├── CMakeLists.txt
├── main
│   ├── CMakeLists.txt
│   └── test_main.c
└── README.md                  This is the file you are currently reading
```

For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide.

## Troubleshooting

* Program upload failure

    * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
    * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.