Sarracen
Sarracen: a Python package for analysis and visualization of smoothed particle hydrodynamics data - Published in JOSS (2023)
Science Score: 95.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 5 DOI reference(s) in README and JOSS metadata -
○Academic publication links
-
✓Committers with academic emails
3 of 15 committers (20.0%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
A Python library for smoothed particle hydrodynamics (SPH) analysis and visualization.
Basic Info
- Host: GitHub
- Owner: ttricco
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://sarracen.readthedocs.io
- Size: 3.33 MB
Statistics
- Stars: 19
- Watchers: 3
- Forks: 20
- Open Issues: 13
- Releases: 6
Metadata Files
README.md
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. Sarracen is published with the Journal of Open Source Software (DOI: 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},
}
Owner
- Name: Terrence Tricco
- Login: ttricco
- Kind: user
- Repositories: 2
- Profile: https://github.com/ttricco
JOSS Publication
Sarracen: a Python package for analysis and visualization of smoothed particle hydrodynamics data
Authors
Memorial University of Newfoundland, Canada
Memorial University of Newfoundland, Canada
Editor
Warrick Ball
Tags
Jupyter Notebook smoothed particle hydrodynamics astronomy astrophysics data visualization data scienceGitHub Events
Total
- Issues event: 3
- Watch event: 4
- Delete event: 3
- Issue comment event: 6
- Push event: 13
- Pull request review comment event: 26
- Pull request review event: 22
- Pull request event: 34
- Fork event: 5
- Create event: 2
Last Year
- Issues event: 3
- Watch event: 4
- Delete event: 3
- Issue comment event: 6
- Push event: 13
- Pull request review comment event: 26
- Pull request review event: 22
- Pull request event: 34
- Fork event: 5
- Create event: 2
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Terrence Tricco | t****o@m****a | 136 |
| Andrew Harris | a****s@m****a | 128 |
| Fathima Manooja | f****a@m****a | 20 |
| Fathima | i****3@g****m | 18 |
| Yona Lapeyre | y****e@e****r | 8 |
| Vasundhara Prasad | v****5@c****k | 5 |
| Jean-Francois Gonzalez | J****z@e****r | 3 |
| j-p-terry | j****y@u****u | 3 |
| katya.nazarenko | k****3@m****a | 3 |
| n2owens | o****n@m****a | 2 |
| Sahl Rowther | s****7@a****r | 2 |
| Antoine Alaguero | 1****A | 1 |
| Griselda Arroyo Chavez | g****h@g****m | 1 |
| Rebecca Nealon | r****n@w****k | 1 |
| Sahl Rowther | s****7@a****r | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 31
- Total pull requests: 125
- Average time to close issues: 5 months
- Average time to close pull requests: 10 days
- Total issue authors: 13
- Total pull request authors: 15
- Average comments per issue: 0.97
- Average comments per pull request: 0.12
- Merged pull requests: 101
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 44
- Average time to close issues: N/A
- Average time to close pull requests: 11 days
- Issue authors: 2
- Pull request authors: 8
- Average comments per issue: 0.0
- Average comments per pull request: 0.11
- Merged pull requests: 26
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ttricco (14)
- casshall (3)
- becnealon (2)
- JBorrow (2)
- zachboots (2)
- danieljprice (1)
- hlim88 (1)
- Shigaharuki3012 (1)
- JackNarvaez (1)
- svaverbe (1)
- adamkoval (1)
- emborchert (1)
- ostueker (1)
Pull Request Authors
- AndrewHarris709 (39)
- ttricco (31)
- FathimaCSgithub (14)
- vasu-prasad (10)
- j-f-gonzalez (6)
- y-lapeyre (4)
- becnealon (4)
- kn8483 (4)
- JackNarvaez (2)
- g-arroyo (2)
- sahl95 (2)
- n2owens (2)
- nvadood (2)
- j-p-terry (2)
- AlagueroA (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 49 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 7
- Total maintainers: 1
pypi.org: sarracen
SPH analysis and visualization
- Documentation: https://sarracen.readthedocs.io/
- License: gpl-3.0
-
Latest release: 1.2.3
published about 2 years ago
Rankings
Maintainers (1)
Dependencies
- matplotlib >=3.6
- numba >=0.55.1
- pandas >=1.4
- scipy >=1.8.0
- seaborn >=0.11
- matplotlib >=3.5.2
- numba >=0.55.1
- pandas >=1.4.2
- scipy >=1.8.0
- seaborn >=0.11.2
- actions/checkout v3 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite