Metadata-Version: 2.1
Name: magentropy
Version: 0.1.1
Summary: Perform magnetoentropic mapping of magnetic materials based on DC magnetization data.
Author-email: Soren Bear <sbear@ucsb.edu>
License: MIT License
        
        Copyright (c) 2022 Soren Bear
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Download, https://pypi.org/project/magentropy/
Project-URL: Bug Tracker, https://github.com/sorenbear/magentropy/issues
Project-URL: Documentation, https://magentropy.readthedocs.io/en/stable/
Project-URL: Source Code, https://github.com/sorenbear/magentropy
Keywords: magentropy,magnetoentropy,magnetoentropic,magnetocaloric,magnetization,materials
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# MagentroPy

```{admonition} References
Please cite the following in any published work that makes use of this package:

> [1] J. D. Bocarsly et al.,
> [Phys. Rev. B 97, 100404(R) (2018)](https://doi.org/10.1103/PhysRevB.97.100404)
>
> [2] J. J. Stickel,
> [Comput. Chem. Eng. 34, 467 (2010)](https://dx.doi.org/10.1016/j.compchemeng.2009.10.007)

The first version of the `magentropy` code was included as supplementary
material in [1]. The Tikhonov regularization procedure was described
in [2] and was originally implemented by Stickel in the package
[scikit.datasmooth](https://github.com/jjstickel/scikit-datasmooth).
```

## Overview

MagentroPy provides a class, `MagentroData`,
that can be used to calculate magnetocaloric quantities from DC magnetization
data supplied as magnetic moment vs. temperature sweeps (monotonic) taken under
several different magnetic fields. The class is set up to work out-of-the-box
with `.dat` data files produced by a Quantum Design Vibrating Sample
Magnetometer or a
[Quantum Design MPMS3 SQUID Magnetometer](https://www.qdusa.com/products/mpms3.html).
However, `pandas.DataFrame`s or delimited files such as `.csv`
are also acceptable inputs.

View the documentation

## Installation

Install MagentroPy with ``pip``:

```{code-block} console
pip install magentropy
```

Or, with ``conda``:

```{code-block} console
conda install -c conda-forge magentropy
```

## License

This project is licensed under the MIT License.
