Metadata-Version: 2.4
Name: sarracen
Version: 1.4.1
Summary: SPH analysis and visualization
Author-email: "Terrence S. Tricco" <tstricco@mun.ca>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENCE
Requires-Dist: matplotlib>=3.6
Requires-Dist: numba>=0.55.1
Requires-Dist: pandas>=2.0
Requires-Dist: numpy>=2.0
Requires-Dist: scipy>=1.8.0
Requires-Dist: seaborn>=0.11
Project-URL: Docs, https://sarracen.readthedocs.io
Project-URL: Source, https://github.com/ttricco/sarracen

Sarracen
========

A Python library for smoothed particle hydrodynamics (SPH) analysis and 
visualization.

About
-----

Sarracen is built upon the pandas, Matplotlib and NumPy libraries. It can load 
SPH particle data into a pandas DataFrame object that has been extended to 
allow for rendering of particle data and interpolation of particles to fixed 
grids. Additionally, this allows for access to the rich landscape of Python 
scientific and statistical libraries. All SPH functions offer multi-threaded 
CPU and CUDA implementations. Our intended application is for astrophysical SPH
data. 

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

The latest stable release and associated dependencies can be installed from 
PyPi:

    pip install sarracen

This is the recommended way to install Sarracen.

To install the latest development snapshot, install using this GitHub 
repository. Either clone the repository and add it to your path so that it can 
be imported, or install directly through pip:

    pip install git+https://github.com/ttricco/sarracen.git

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

Sarracen's documentation is hosted online at 
[https://sarracen.readthedocs.io](https://sarracen.readthedocs.io). 

The documentation contains examples and full API references.

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

Contributions are welcomed and appreciated. Here are some ways to get involved:
- Submitting bug reports.
- Feature requests or suggestions.
- Improving the documentation or providing examples.
- Writing code to add optimizations or new features.

Please use the [GitHub issue tracker](https://github.com/ttricco/sarracen/issues) to raise any bugs or to submit 
feature requests. If something does not work as you might expect, please let us
know. If there are features that you feel are missing, please let us know.

Code submissions should be submitted as a pull request. Make sure that all 
existing unit tests successfully pass, and please add any new unit tests that 
are relevant. Documentation changes should also be submitted as a pull request.

If you are stuck or need help, 
[raising an issue](https://github.com/ttricco/sarracen/issues) is a good place 
to start. This helps us keep common issues in public view. Feel free to also 
[email](mailto:tstricco@mun.ca) with questions.

Please note that we adhere to a [code of conduct](CODE_OF_CONDUCT.md).

Citation
--------

Please cite the paper if you use Sarracen within your work. Sarracen is 
published with the Journal of Open Source Software (DOI: 
[10.21105/joss.05263](https://doi.org/10.21105/joss.05263)).

```
@ARTICLE{Sarracen,
       author = {{Harris}, Andrew and {Tricco}, Terrence},
        title = "{Sarracen: a Python package for analysis and visualization of smoothed particle hydrodynamics data}",
      journal = {The Journal of Open Source Software},
     keywords = {smoothed particle hydrodynamics, data visualization, Python, data science, Jupyter Notebook, astrophysics, astronomy},
         year = 2023,
        month = jun,
       volume = {8},
       number = {86},
          eid = {5263},
        pages = {5263},
          doi = {10.21105/joss.05263},
}
```
