Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 2.63 KB

README.md

File metadata and controls

61 lines (42 loc) · 2.63 KB
Raw

Maat v2.4.2

Welcome to My AnAlysis Tools; or just Maat, as the Egyptian goddess of truth, order, and justice.

Just as an egyptian goddess fallen from the sky, this Python package makes my life easier when analyzing INS, FTIR and Raman CSV data files, among others. Bear in mind that, as any egyptian god, Maat is not perfect and may be full of bugs. Please report any issues you may find.

Installation

As always, it is strongly recommended to install this package inside a Python virtual environment.

Install the required dependencies by running:

pip install numpy pandas matplotlib scipy

To install Maat, clone the repository from GitHub or download it as a ZIP and run:

pip install .

Usage

You can check the latest documentation online. An offline copy is also available in /docs/maat.html. Note that code examples are also provided in the /examples/ folder.

Maat has the following submodules:

  • Classes. Here are the objects that allow you to work with the data. Loaded directly as maat.Class(options).
  • Constants. Common constants and conversion factors. Loaded directly as maat.value.
  • Fit. Fitting operations.
  • Normalize. Normalization operations.
  • Plot. Plotting operations.
  • Deuteration. Deuteration estimation.
  • Sample. Sample data for testing.
  • Utils. Utility functions to make things easier.

The documentation can be compiled automatically using pdoc, by running:

source pdoc.sh

License

TL;DR: Do what you want with this, as long as you share the source code of your modifications, also under GNU AGPLv3.

Copyright (C) 2024 Pablo Gila-Herranz

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the attached GNU Affero General Public License for more details.