Metadata-Version: 2.4
Name: electroacoustics-auth
Version: 1.0.3
Summary: Electroacoustics Python distribution package supporting Aristotle University of Thessaloniki educational courses.
Author-email: Christos Sevastiadis <csevast@auth.gr>
License-Expression: GPL-3.0-or-later
Project-URL: Home, https://sr.ht/~csevast/electroacoustics-auth/
Project-URL: Source, https://hg.sr.ht/~csevast/electroacoustics-auth
Keywords: electroacoustics,acoustics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: MacOS X
Classifier: Environment :: Win32 (MS Windows)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: IPython
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: scipy
Dynamic: license-file

# Electroacoustics-AUTH

Electroacoustics-AUTH is a Python distribution package that supports the teaching of Electroacoustics courses at Aristotle University of Thessaloniki. It consists of a tool library, ``electroacoustics``, which contains constants, functions, and other Python objects used in lectures, exercises, and teaching materials, primarily within Jupyter Notebooks.

## 📦 Installation

### Install via PyPI

You can install this package from [PyPI](https://pypi.org) using `pip`:

```
pip install electroacoustics-auth
```

### Install via Conda

To install this package using [conda](https://docs.conda.io), make sure you have either [Miniconda](https://docs.conda.io/en/latest/miniconda.html) or [Anaconda](https://www.anaconda.com/products/distribution) installed.

Then, run the following command:

```
conda install csevast::electroacoustics-auth
```

## ✅ Installation verification
To check if the package was installed successfully, try:
```
python -c "import electroacoustics; help(electroacoustics)"
```
If the **electroacoustics-auth** is installed, this command will print all of its help documentation string.

# 💻 Examples of usage
To use the main module `electroacoustics` import it in your programm:
```
import electroacoustics as ea
```
or
```
import electroacoustics.electroacoustics as ea
```
To initialize a Jupyter Notebook for the Electroacoustics courses insert at the beginning of its first Python cell the following code:
```
from electroacoustics.init_ipynb import *
```

## ⚖️ License: GNU GPL v3.0 or later

Copyright (C) 2026 Christos Sevastiadis

This program is free software: you can redistribute it and/or modify it under the terms of the GNU 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 GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. 
