Metadata-Version: 2.1
Name: planetboundmass
Version: 0.1.2
Summary: Toolkit to find and analysis bound particles from planetary SWIFTsim simulations
Home-page: https://github.com/JingyaoDOU/planetboundmass
Author: Jingyao Dou
Author-email: Jingyao Dou <jingyao.dou@bristol.ac.uk>
License: MIT License
        
        Copyright (c) 2023 Jingyao Dou
        
        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: Homepage, https://github.com/JingyaoDOU/planetboundmass
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: <=3.8.18
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: pandas
Requires-Dist: h5py
Requires-Dist: woma
Requires-Dist: unyt
Requires-Dist: swiftsimio
Requires-Dist: scipy
Requires-Dist: seaborn

Python version of bound mass particle searcher originally written in C by Philip J. Carter. [Carter et al. 2018](https://ui.adsabs.harvard.edu/abs/2018E&PSL.484..276C/abstract)

Usage
======
See the `tutorial.ipynb` notebook for an introductory tutorial and examples.

Install
=======
First, create and activate your conda environment and then install it with `pip`
```Shell
conda create -n env python=3.8.18
conda activate env
pip install planetboundmass
```
