Skip to main content

SPH analysis and visualization

Project description

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.

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 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 is a good place to start. This helps us keep common issues in public view. Feel free to also email with questions.

Please note that we adhere to a code of conduct.

Citation

Please cite the paper if you use Sarracen within your work (DOI: 10.21105/joss.05263).

Sarracen: a Python package for analysis and visualization of smoothed particle hydrodynamics data. Journal of Open Source Software, 8(86), 5263, 2023.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sarracen-1.2.3.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

sarracen-1.2.3-py3-none-any.whl (60.7 kB view details)

Uploaded Python 3

File details

Details for the file sarracen-1.2.3.tar.gz.

File metadata

  • Download URL: sarracen-1.2.3.tar.gz
  • Upload date:
  • Size: 2.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for sarracen-1.2.3.tar.gz
Algorithm Hash digest
SHA256 ee329bcb4c4b673acf6dfd7af0beedac08a90dc5bdc24ff46a8d595e9bcaec97
MD5 7f2d844b9fed4e897928efa46ebcff41
BLAKE2b-256 2f692312f0f5a0a860155a30d91f630b9f1078c5267feb6c238be2231f208384

See more details on using hashes here.

File details

Details for the file sarracen-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: sarracen-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 60.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.2

File hashes

Hashes for sarracen-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6ada9469d5333522dd943ecd38bbf8ec2b5ebe46397b9ac35bd2e918336656d3
MD5 032c17a54d30e3bee1de84426a3ad31b
BLAKE2b-256 c6704f2747428c64e7ed16ca5a3ff9bec6681c18deb5c28da3443bbc1c6adb10

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page