A library containing general purpose utils.

Table of contents

• Introduction
• Install and run
• Extra documentation
• List of features
  • Data science
  • Mathematics
  • Parallelization
  • Plotter
• Credits
  • Project leaders
• Stargazers over time

Introduction

This library contains a set of generic utils I developed for other projects. There are several sub-headers / modules related to various topics (mathematics, threading etc...).

Existing tools are constantly updated and new ones are added once their development is required for other projects.

If you want to use this library please cite it following this citation template.

The software is and will stay free, but if you want to support me with a donation it would be really appreciated!

Supported operating systems:

• Linux (Ubuntu and WSL tested)
• Windows 10.
• MaxOS.

Install and run

Steps to be reproduced:

1) Install the library and prerequisites.

bash pip install arsenalgear

To run examples:

python python examples.py

2) Use in your device

Once you have installed the library you can freely use it in one of your Python projects by including one or more of the modules:

python from arsenalgear import module_name

for example:

Python from arsenalgear import mathematics

3) Run the tests (optional):

If you want to run the tests you have to type:

shell python src/arsenalgear/module_name

If anything is displayed it means that tests ran correctly.

Tests have been performed using the Doctest framework.

If you want a detailed tests log printed on the screen, simply enter:

shell python src/arsenalgear/module_name -v

Extra documentation

• Contributing to the repository: a generic file containing detailed info about how to open an issue or send a pull request to contribute.
• Code documentation: code documentation has been generated using Doxygen.

List of features

Data science

• AMS_score: function used to retrieve the AMS score.
• RemoveOutliers: function used to remove the outliers of an array.
• RemoveOutliers_DF: function used to remove the outliers of a dataframe.

Mathematics

• Hermite: function used to retrieve Hermite polynomials values.
• Chebyshev: function used to retrieve Chebyshev polynomials values.
• Legendre: function used to retrieve Legendre polynomials values.
• Laguerre: function used to retrieve Laguerre polynomials values.
• IsInBounds: function used to check if a value is in a certain bound or not.
• e_parser: function used to return the complex value of a parsed expression.
• kronecker: function used to compute the Kronecker delta.
• OrderOfMagnitude: function used to find the order og magnitude of a number.

Parallelization

• MultiProcesses: function used to parallelize more functions.
• chunker: function used send a bunch of processes in parallel.

Plotter

• plot_AMS: function used to plot the AMS score.
• plotter_complex: function used to plot a given function for an index n.
• plot_learning_curve: function used to plot a learning curves for train and tests sets of a dataset.

Utils

• TimeToInt: function used to convert a time-string into an integer.
• IntToTime: function used to convert an integer into a time-string.
• save_img: function used to save an image in a certain position of the system.

Credits

Project leaders

Gianluca Bianco

Stargazers over time