Metadata-Version: 2.1
Name: quosc
Version: 0.2.0
Summary: Simulating quantum oscillations
Home-page: https://github.com/mihirm2305/quosc
Author: Mihir Manium
License: MIT License
        
        Copyright (c) 2024 Mihir Manium
        
        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.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: joblib
Requires-Dist: trimesh
Requires-Dist: scikit-image
Requires-Dist: scikit-learn
Requires-Dist: pandas
Requires-Dist: shapely
Requires-Dist: rtree
Requires-Dist: seaborn

# QuOsc

QuOsc is a python package for simulating quantum oscillations in torque magnetometry. It performs the following steps:

1. Read the `interpolation.bt2` file generated by BoltzTraP2, to read the interpolated band structure and generate the Fermi surface.
2. For each magnetic field direction, find the extremal cross-sections of the Fermi surface.
3. For the extremal cross-sections, calculate the quantum oscillation frequencies, effective masses, and other relevant parameters.
4. Use the calculated parameters to simulate the quantum oscillations in torque magnetometry and take FFT to extract the quantum oscillation frequencies.

## Installation

To install QuOsc, run the following command:

```bash
pip install quosc
```

## Usage

