swiftsimio
swiftsimio: A Python library for reading SWIFT data - Published in JOSS (2020)
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
Links to: arxiv.org, joss.theoj.org -
✓Committers with academic emails
9 of 22 committers (40.9%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Keywords
Scientific Fields
Repository
Python library for reading SWIFT data. Uses unyt and h5py.
Basic Info
Statistics
- Stars: 25
- Watchers: 9
- Forks: 12
- Open Issues: 21
- Releases: 31
Topics
Metadata Files
README.md
SWIFTsimIO
The SWIFT astrophysical simulation code (http://swift.dur.ac.uk) is used
widely. There exists many ways of reading the data from SWIFT, which outputs
HDF5 files. These range from reading directly using h5py to using a complex
system such as yt; however these either are unsatisfactory (e.g. a lack of
unit information in reading HDF5), or too complex for most use-cases.
swiftsimio provides an object-oriented API to read (dynamically) data
from SWIFT.
Full documentation is available at ReadTheDocs.
Getting set up with swiftsimio is easy; it (by design) has very few
requirements. There are a number of optional packages that you can install
to make the experience better and these are recommended.
Requirements
This requires python v3.10.0 or higher. Unfortunately it is not
possible to support swiftsimio on versions of python lower than this.
It is important that you upgrade if you are still a python2 user.
Python packages
numpy, required for the core numerical routines.h5py, required to read data from the SWIFT HDF5 output files.unyt, required for symbolic unit calculations (depends on sympy`).
Optional packages
numba, highly recommended should you wish to use the in-built visualisation tools.scipy, required if you wish to generate smoothing lengths for particle types that do not store this variable in the snapshots (e.g. dark matter)tqdm, required for progress bars for some long-running tasks. If not installed no progress bar will be shown.py-sphviewer, if you wish to use our integration with this visualisation code.
Installing
swiftsimio can be installed using the python packaging manager, pip,
or any other packaging manager that you wish to use:
pip install swiftsimio
Citing
Please cite swiftsimio using the JOSS paper:
bibtex
@article{Borrow2020,
doi = {10.21105/joss.02430},
url = {https://doi.org/10.21105/joss.02430},
year = {2020},
publisher = {The Open Journal},
volume = {5},
number = {52},
pages = {2430},
author = {Josh Borrow and Alexei Borrisov},
title = {swiftsimio: A Python library for reading SWIFT data},
journal = {Journal of Open Source Software}
}
If you use any of the subsampled projection backends, we ask that you cite our relevant SPHERIC paper. Note that citing the arXiv version here is recommended as the ADS cannot track conference proceedings well.
bibtex
@article{Borrow2021
title={Projecting SPH Particles in Adaptive Environments},
author={Josh Borrow and Ashley J. Kelly},
year={2021},
eprint={2106.05281},
archivePrefix={arXiv},
primaryClass={astro-ph.GA}
}
Owner
- Name: SWIFT astrophysics simulation code and ecosystem of tools
- Login: SWIFTSIM
- Kind: organization
- Location: Netherlands
- Website: www.swiftsim.com
- Twitter: swiftsimulation
- Repositories: 14
- Profile: https://github.com/SWIFTSIM
SWIFT: SPH With Inter-dependent Fine-grained Tasking
JOSS Publication
swiftsimio: A Python library for reading SWIFT data
Authors
Institute for Computational Cosmology, Durham University
School of Physics and Astronomy, University of Edinburgh
Editor
Dan Foreman-Mackey
Tags
Python astronomy cosmology simulations i/oGitHub Events
Total
- Create event: 23
- Release event: 4
- Issues event: 36
- Watch event: 6
- Delete event: 17
- Issue comment event: 67
- Push event: 149
- Pull request review comment event: 25
- Pull request review event: 38
- Pull request event: 36
Last Year
- Create event: 23
- Release event: 4
- Issues event: 36
- Watch event: 6
- Delete event: 17
- Issue comment event: 67
- Push event: 149
- Pull request review comment event: 25
- Pull request review event: 38
- Pull request event: 36
Committers
Last synced: 5 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Josh Borrow | j****w@d****k | 517 |
| Kyle Oman | k****n@d****k | 103 |
| Alexei Borissov | d****1@l****k | 63 |
| Yolan Uyttenhove | y****e@u****e | 25 |
| Alexei Borissov | d****1@l****k | 24 |
| Bert Vandenbroucke | v****e@s****l | 22 |
| robjmcgibbon | r****n@g****m | 18 |
| Matthieu Schaller | s****r@s****l | 14 |
| Alexei Borissov | d****1@l****k | 10 |
| loikki | l****n@p****m | 7 |
| Mladen Ivkvoic | m****c@h****m | 6 |
| Bert Vandenbroucke | b****e@g****m | 5 |
| Bert Vandenbroucke | d****2@l****k | 5 |
| John Helly | j****y@d****k | 3 |
| Aidan Chalk | a****k@s****k | 3 |
| Alexei Borissov | d****1@l****r | 3 |
| loikki | l****n@p****h | 2 |
| Folkert Nobels | n****s@s****l | 1 |
| Jacob Kegerreis | j****s@d****k | 1 |
| Victor J. Forouhar Moreno | 6****r | 1 |
| Willem Elbers | w****s@d****k | 1 |
| nickishch | n****h@g****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 75
- Total pull requests: 136
- Average time to close issues: 11 months
- Average time to close pull requests: 18 days
- Total issue authors: 28
- Total pull request authors: 14
- Average comments per issue: 3.45
- Average comments per pull request: 2.33
- Merged pull requests: 123
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 19
- Pull requests: 53
- Average time to close issues: 2 months
- Average time to close pull requests: 12 days
- Issue authors: 10
- Pull request authors: 6
- Average comments per issue: 1.63
- Average comments per pull request: 1.75
- Merged pull requests: 45
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- kyleaoman (19)
- MatthieuSchaller (10)
- JBorrow (8)
- bwvdnbro (5)
- joe637 (3)
- yrevaz (3)
- JegerBroxterman (3)
- mladenivkovic (3)
- Fonotec (2)
- Joeybraspenning (2)
- VictorForouhar (2)
- filipello (1)
- boson112358 (1)
- yanlingchen1 (1)
- WillJRoper (1)
Pull Request Authors
- kyleaoman (58)
- JBorrow (39)
- bwvdnbro (13)
- robjmcgibbon (10)
- aborissov (7)
- MatthieuSchaller (5)
- mladenivkovic (5)
- yuyttenhove (4)
- jchelly (2)
- nickishch (2)
- VictorForouhar (2)
- loikki (1)
- harryjmoss (1)
- wullm (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 3,551 last-month
- Total dependent packages: 2
- Total dependent repositories: 7
- Total versions: 79
- Total maintainers: 2
pypi.org: swiftsimio
SWIFTsim (swiftsim.com) i/o routines for python.
- Homepage: https://github.com/SWIFTSIM/swiftsimio
- Documentation: https://swiftsimio.readthedocs.io/en/latest
- License: GNU Lesser General Public License v3 or later (LGPLv3+)
-
Latest release: 10.5.0
published 5 months ago
Rankings
Maintainers (2)
Dependencies
- recommonmark *
- sphinx *
- sphinx-rtd-theme *
- h5glance *
- py-sphviewer *
- swiftsimio *
- velociraptor *
- wily *
- black *
- matplotlib *
- numba *
- py-sphviewer *
- pytest *
- scipy *
- wily *
- astropy *
- h5py *
- numba *
- numpy *
- unyt *
- numpy *