Science Score: 77.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
6 of 33 committers (18.2%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
yt astrophysical analysis modules
Basic Info
Statistics
- Stars: 24
- Watchers: 8
- Forks: 21
- Open Issues: 20
- Releases: 5
Topics
Metadata Files
README.md
The yt Astro Analysis Extension
This is ytastroanalysis, the yt extension package for astrophysical analysis. This package contains functionality for:
- Halo finding and analysis
- Lightcones
- Planning cosmological simulations for making lightcones and lightrays
- Exporting to the RADMC-3D radiation transport code
- Creating PPV FITS cubes
This is primarily machinery that used to be in yt's analysis_modules. These were made into a separate package to allow yt to become less astro-specifc and to allow these modules to be developed on their own schedule.
Installation
Full installation documentation can also be found here.
Stable
Get the latest release via pip as
shell
python -m pip install yt-astro-analysis
Or with conda, as
shell
conda install -c conda-forge yt-astro-analysis
Note, the package name is spelled with hyphens (yt-astro-analysis)
when installing from pip or conda. With pip, the package name can be
spelled with either hyphens or underscores, but with conda it must
always be hyphens.
From source
To build yt_astro_analysis from source, clone the git repository and install
as
shell
git clone https://github.com/yt-project/yt_astro_analysis
cd yt_astro_analysis
python -m pip install -e .
Installing with Rockstar support
In order to run the Rockstar halo finder from within ytastroanalysis, it is
necessary to install ytastroanalysis from source.
You will need to install rockstar-galaxies from either
John Wise's
repository or Peter
Behroozi's
repository. To
install Rockstar, do the following:
git clone https://bitbucket.org/jwise77/rockstar-galaxies
cd rockstar-galaxies
make lib
Then, go into the ytastroanalysis source directory and add a file called "rockstar.cfg" with the path the Rockstar repo you just cloned. Then, install ytastroanalysis.
cd yt_astro_analysis
echo <path_to_rockstar> > rockstar.cfg
python -m pip install -e .
Finally, you'll need to make sure that the location of
librockstar-galaxies.so is in your LDLIBRARYPATH.
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<path_to_rockstar>
Importing from ytastroanalysis
For every module that was moved from yt's analysismodules to ytastroanalysis,
all imports can be changed simply by substituting ``yt.analysismoduleswith
yt.extensions.astro_analysis``. For example, the following
python
from yt.analysis_modules.ppv_cube.api import PPVCube
becomes
python
from yt.extensions.astro_analysis.ppv_cube.api import PPVCube
Contributing
We really want your contributions! As an official yt-project extension, everything in the yt Contributor Guide applies here.
If you'd rather make your own standalone package, we want to support that, too! Please, consider making your package a yt extension.
Resources
As an extension of the yt-project, the yt resources are available for help.
- The latest documentation can be found at https://yt-astro-analysis.readthedocs.io/
Owner
- Name: The yt project
- Login: yt-project
- Kind: organization
- Email: yt-users@python.org
- Website: http://yt-project.org/
- Repositories: 43
- Profile: https://github.com/yt-project
A toolkit for analysis and visualization of volumetric data
Citation (CITATION.rst)
Citing yt_astro_analysis
========================
If you use the yt_astro_analysis package for your work, please cite the
`yt_astro_analysis <https://zenodo.org/record/1458961#.W8ZcVXFKht8>`__
entry on `zenodo.org <https://zenodo.org/>`_ as well as the
`yt method paper <http://adsabs.harvard.edu/abs/2011ApJS..192....9T>`__.
Feel free to use the text below in your publications:
::
Analysis was performed using the yt_astro_analysis extension
(Smith et al. 2022) of the yt analysis toolkit (Turk et al. 2011).
Analysis was performed using the yt_astro_analysis extension
\citep{yt.astro.analysis} of the yt analysis toolkit \citep{yt}.
BbTeX entries are provided below:
::
@misc{yt.astro.analysis,
author = {Britton Smith and
Matthew Turk and
John ZuHone and
Nathan Goldbaum and
Cameron Hummels and
Hilary Egan and
John Wise and
Anthony Scopatz and
Miguel de Val-Borro and
Ben Keller and
Mark Richardson and
Clément Robert},
title = {yt_astro_analysis version 1.1.2},
month = jan,
year = 2022,
doi = {10.5281/zenodo.5911048},
url = {https://doi.org/10.5281/zenodo.5911048}
}
@ARTICLE{yt,
author = {{Turk}, M.~J. and {Smith}, B.~D. and {Oishi}, J.~S. and {Skory}, S. and
{Skillman}, S.~W. and {Abel}, T. and {Norman}, M.~L.},
title = "{yt: A Multi-code Analysis Toolkit for Astrophysical Simulation Data}",
journal = {The Astrophysical Journal Supplement Series},
archivePrefix = "arXiv",
eprint = {1011.3514},
primaryClass = "astro-ph.IM",
keywords = {cosmology: theory, methods: data analysis, methods: numerical},
year = 2011,
month = jan,
volume = 192,
eid = {9},
pages = {9},
doi = {10.1088/0067-0049/192/1/9},
adsurl = {http://adsabs.harvard.edu/abs/2011ApJS..192....9T},
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
}
GitHub Events
Total
- Issues event: 3
- Watch event: 1
- Delete event: 7
- Issue comment event: 6
- Push event: 12
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 12
- Create event: 6
Last Year
- Issues event: 3
- Watch event: 1
- Delete event: 7
- Issue comment event: 6
- Push event: 12
- Pull request review event: 1
- Pull request review comment event: 1
- Pull request event: 12
- Create event: 6
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Britton Smith | b****h@g****m | 487 |
| Matthew Turk | m****k@g****m | 141 |
| John ZuHone | j****e@g****m | 139 |
| Nathan Goldbaum | n****u@i****u | 92 |
| Clément Robert | c****2@p****m | 92 |
| Stephen Skory | s@s****s | 76 |
| pre-commit-ci[bot] | 6****] | 49 |
| Cameron Hummels | c****s@g****m | 35 |
| Andrew Myers | a****2@g****m | 35 |
| Hilary Egan | h****e@g****m | 32 |
| Christopher Moody | c****y@u****u | 28 |
| Kacper Kowalik | x****k@g****m | 27 |
| dependabot[bot] | 4****] | 23 |
| Corentin Cadiou | c****u@i****r | 21 |
| Sam Skillman | s****n@g****m | 19 |
| Mike Warren | m****n@g****m | 11 |
| John Wise | j****e@p****u | 9 |
| Joshua Moloney | j****y@c****u | 8 |
| Douglas Rudd | d****d@u****u | 7 |
| Geoffrey So | g****g@g****m | 6 |
| Pengfei Chen | m****f@g****m | 4 |
| Sam Leitner | s****r@g****m | 4 |
| convert-repo | n****e@n****e | 4 |
| Miguel de Val-Borro | m****l@g****m | 3 |
| Anthony Scopatz | s****z@g****m | 3 |
| Michael Kuhlen | m****k@a****u | 2 |
| willsonho2000 | 7****0 | 2 |
| Casey W. Stark | c****k@g****m | 2 |
| Mark Richardson | M****k@g****m | 1 |
| Matthew Krafczyk | k****w@g****m | 1 |
| and 3 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 23
- Total pull requests: 149
- Average time to close issues: 6 months
- Average time to close pull requests: 6 days
- Total issue authors: 9
- Total pull request authors: 9
- Average comments per issue: 2.57
- Average comments per pull request: 0.83
- Merged pull requests: 129
- Bot issues: 0
- Bot pull requests: 66
Past Year
- Issues: 3
- Pull requests: 13
- Average time to close issues: N/A
- Average time to close pull requests: 21 days
- Issue authors: 3
- Pull request authors: 3
- Average comments per issue: 0.0
- Average comments per pull request: 0.46
- Merged pull requests: 7
- Bot issues: 0
- Bot pull requests: 11
Top Authors
Issue Authors
- neutrinoceros (10)
- brittonsmith (4)
- osokoliuk (1)
- cphyc (1)
- Anirban-096 (1)
- mabruzzo (1)
- Redemption007 (1)
- Ecskrabacz10 (1)
- chummels (1)
Pull Request Authors
- neutrinoceros (60)
- pre-commit-ci[bot] (42)
- dependabot[bot] (38)
- brittonsmith (15)
- cphyc (10)
- jzuhone (1)
- spectram (1)
- matthewturk (1)
- mtryan83 (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- pypi 616 last-month
-
Total dependent packages: 0
(may contain duplicates) -
Total dependent repositories: 1
(may contain duplicates) - Total versions: 8
- Total maintainers: 3
pypi.org: yt-astro-analysis
yt astrophysical analysis modules extension
- Homepage: https://yt-project.org/
- Documentation: https://yt-astro-analysis.readthedocs.io/
- License: BSD 3-Clause
-
Latest release: 1.1.3
published over 2 years ago
Rankings
Maintainers (3)
conda-forge.org: yt-astro-analysis
- Homepage: https://github.com/yt-project/yt_astro_analysis
- License: BSD-3-Clause
-
Latest release: 1.1.1
published about 4 years ago
Rankings
conda-forge.org: yt_astro_analysis
- Homepage: http://yt-project.org/
- License: BSD 3-clause
-
Latest release: 1.0.0
published over 7 years ago
Rankings
Dependencies
- actions/checkout v2 composite
- actions/download-artifact v2 composite
- actions/upload-artifact v2 composite
- pypa/cibuildwheel v2.11.4 composite
- pypa/gh-action-pypi-publish v1.4.2 composite
- h5py >=3.1.0
- yt >=4.0.1
- jinja2 ==3.1.2
- markupsafe ==2.1.3
- sphinx ==7.2.6
- sphinx-bootstrap-theme ==0.8.1
- astropy * test
- codecov * test
- girder-client * test
- nose * test
- nose-timer * test
- pytest * test
- scipy * test