Metadata-Version: 2.4
Name: evaluix
Version: 0.9.4.3
Summary: Data Evaluation Software of the (Magnetism) research group of Prof. Ehresmann at University of Kassel
License: MIT
License-File: LICENSE
Keywords: evaluix,hysteresis
Author: Arne Jan Vereijken
Author-email: arne.vereijken@physik.uni-kassel.de
Requires-Python: >=3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: NSFopen (>=2.0.0)
Requires-Dist: exp4-agepy (>=0.2)
Requires-Dist: h5py
Requires-Dist: ipykernel (>=6.0.3)
Requires-Dist: lmfit
Requires-Dist: matplotlib
Requires-Dist: numpy (>=1.24.2)
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: pyqt6 (>=6.4.2)
Requires-Dist: pyyaml
Requires-Dist: scikit-image
Requires-Dist: scikit-learn
Requires-Dist: scipy
Requires-Dist: tqdm
Project-URL: Homepage, https://github.com/exp4-age/evaluix
Project-URL: Repository, https://github.com/exp4-age/evaluix
Description-Content-Type: text/x-rst

evaluix
=======

.. image:: https://img.shields.io/badge/version-0.9.4.3-blue
   :target: https://img.shields.io/badge/version-0.9.4.3-blue
.. image:: https://img.shields.io/badge/License-MIT-blue
   :target: https://github.com/exp4-age/evaluix/blob/main/LICENSE

Data Evaluation Software of Arbeitsgruppe Ehresmann (Magnetism)

Installation
------------

Install with ::

    pip install evaluix

If you want to help develop and contribute to the package, first clone
the repository to your PC and install in editable mode (detailed 
tutorial is about to come)::

    git clone https://github.com/exp4-age/evaluix.git or git clone https://github.com/exp4-age/evaluix.git@branch_name (if you want to clone a specific branch)
    cd evaluix
    pip install -e .

Recommendation for Students and Beginners
-----------------------------------------

Install Anaconda and create a new environment with Python 3.9 or higher. Activate it in an anaconda prompt
and install evaluix as follows ::

    conda create -n myevaluix python=3.9 (or higher, answer with y if asked)

    conda activate myevaluix

    conda install pip (if necessary)

    pip install evaluix (answer with y if asked)

Edit: The gui is currently unavailable. 
Now you can start the software by typing `evaluix` in the anaconda prompt ::

    conda activate myevaluix (if not already activated)

    evaluix

Documentation
-------------

https://evaluix.readthedocs.io/en/core-functionality/index.html

Contributing
------------

About to come
