Metadata-Version: 2.1
Name: py-particle-analysis
Version: 0.0.1
Summary: Python Package for particle distribution analysis with a focus on ImpactZ and ImpactT file types
Author-email: Lucas Malin <lukemalin@gmail.com>
License: MIT License
        
        Copyright (c) 2021 lm314
        
        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/lm314/py-particle-analysis
Project-URL: Bug Tracker, https://github.com/lm314/py-particle-analysis/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# pyPartAnalysis

Package for processing ImpactT and ImpactZ particle distributions as well as performing analysis on particle distributions in pandas dataframes.

## Compatibility

Compatible with Python 3.8.5.

Works with the default NERSC python module as of June 5th, 2022.

## Adding Directory to PYTHONPATH on NERSC

To make the `pyPartAnalysis` module available on the Python and Jupyter path, add the following lines to the `.bashrc` file in the home directory:

```bash
export PYTHONPATH='/global/homes/firstletterofusername/username/pyPartAnalysis'
export JUPYTER_PATH='/global/homes/firstletterofusername/username/pyPartAnalysis'
```

Note that we assume that the directory is in the home directory of 'username', where username is replaced with your name; though the path can be to wherever the module is eventually stored.

## Example Use Cases for ImpactT/Z

Example Jupyter notebooks using ImpactT and ImpactZ output files can by found [here](examples/). This package can be useful for creating interesting visualizations of from the particle distributions, such as the ones below:

<p align='center'><img src=".\examples\1-ImpactT_distribution\NormalizedPhaseSpaceVsSlice.png"></p>
<p align='center'><em>Series of z slices along the normalized x phase space.</em></p>

<p align='center'><img src=".\examples\4-Bunching Factor\bunching_area.gif"></p>
<p align='center'><em>Transversely binned bunching factor vs wavelength.</em></p>
