clustertools
clustertools: A Python Package for Analyzing Star Cluster Simulations - 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 10 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
✓Committers with academic emails
2 of 9 committers (22.2%) from academic institutions -
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Repository
A Python package with tools for analysing star clusters.
Basic Info
- Host: GitHub
- Owner: webbjj
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://clustertools.readthedocs.io
- Size: 90.7 MB
Statistics
- Stars: 15
- Watchers: 2
- Forks: 6
- Open Issues: 2
- Releases: 2
Metadata Files
README.md
clustertools
clustertools is a Python package for analysing star cluster simulations. The package is built around the StarCluster class, which will store all the necessary information from a given star cluster simulation to be used for anaylsis. All functions within clustertools are then designed to act on a StarCluster. clustertools can be used for unit and coordinate transformations, the calculation of key structural and kinematic parameters, analysis of the cluster’s orbit and tidal tails (with the help of galpy , and measuring common cluster properties like its mass function, density profile, and velocity dispersion profile (among others). While originally designed with star clusters in mind, clustertools can be used to study other types of N-body systems, including stellar streams and dark matter sub-halos.
The package contains functions for loading data from commonly used N-body codes, generic snapshots, and codes for generating initial conditions.
clustertools is developed on Github. Please go to https://github.com/webbjj/clustertools to report issues or contribute to the code.
Documentation for clustertools can be found at https://clustertools.readthedocs.io/en/latest/
Installation
clustertools can be installed either directly from the GitHub repository or via pip
To install clustertools from GitHub, simply clone the repository and install via setup tools:
git clone https://github.com/webbjj/clustertools.git cd clustertools python setup.py install Please note that if you don’t have permission to write files to the default install location (often /usr/local/lib), you will either need to run
sudo python setup.py install or
python setup.py install --prefix='PATH' where ‘PATH’ is a directory that you do have permission to write in and is in your PYTHONPATH.
It is also possible to install clustertools using pip:
pip install clustertools however please note this version is not updated as frequently as the GitHub repository. Similarly, if permissions are an issue, you can use:
pip install --user clustertools or
pip install clustertools --install-option="--prefix=PATH"
Note: For users looking to take advantage of the plotting features available in clustertools, it may be necessary to install the cm-super and dvipng packages if they aren't installed by default.
Requirements
clustertools requires the following python packages:
galpy (https://docs.galpy.org/en/v1.7.2/index.html) matplotlib numpy scipy astropy numba
Optional: limepy (https://readthedocs.org/projects/limepy/) AMUSE (https://amuse.readthedocs.io/en/latest/)
JOSS Publication
Markdown:
HTML:
reStructuredText: .. image:: https://joss.theoj.org/papers/10.21105/joss.04483/status.svg :target: https://doi.org/10.21105/joss.04483
Owner
- Login: webbjj
- Kind: user
- Repositories: 5
- Profile: https://github.com/webbjj
JOSS Publication
clustertools: A Python Package for Analyzing Star Cluster Simulations
Authors
David A. Dunlap Department of Astronomy and Astrophysics, University of Toronto, 50 St. George Street, Toronto, ON, M5S 3H4, Canada
Editor
Christina Hedges
Tags
astronomy star clusters N-body simulationsGitHub Events
Total
- Issues event: 1
- Watch event: 1
- Issue comment event: 2
- Push event: 2
Last Year
- Issues event: 1
- Watch event: 1
- Issue comment event: 2
- Push event: 2
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| webbjj | w****w@g****m | 467 |
| Jeremy Webb UofT | w****e@J****l | 57 |
| Erik Gillis | e****s@m****a | 10 |
| Nathaniel Starkman | n****n@p****m | 7 |
| Steven Rieder | s****b@r****l | 1 |
| Jo Bovy | b****y@a****a | 1 |
| Dan F-M | f****y@g****m | 1 |
| Jeremy Webb | j****b@J****l | 1 |
| Jeremy Webb | j****b@J****l | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 7
- Average time to close issues: about 1 month
- Average time to close pull requests: 1 day
- Total issue authors: 2
- Total pull request authors: 6
- Average comments per issue: 2.0
- Average comments per pull request: 1.43
- Merged pull requests: 6
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 1
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 2.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jeremykaram (2)
- webbjj (2)
Pull Request Authors
- nstarman (1)
- e-gillis (1)
- jobovy (1)
- webbjj (1)
- rieder (1)
- dfm (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 71 last-month
- Total dependent packages: 0
- Total dependent repositories: 3
- Total versions: 14
- Total maintainers: 1
pypi.org: clustertools
A python packaged for analysing star clusters
- Documentation: https://clustertools.readthedocs.io/
- License: MIT
-
Latest release: 1.1.0
published almost 3 years ago
Rankings
Maintainers (1)
Dependencies
- astropy *
- cython *
- nbsphinx *
- numpydoc *
- sphinx_automodapi *
- galpy *
- numba *
- seaborn *
- actions/checkout v2 composite
- actions/upload-artifact v1 composite
- openjournals/openjournals-draft-action master composite