Hoki

Hoki: Making BPASS accessible through Python - Published in JOSS (2020)

https://github.com/heloises/hoki

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, zenodo.org
✓
Committers with academic emails
3 of 11 committers (27.3%) from academic institutions
○
Institutional organization owner
✓
JOSS paper metadata
Published in Journal of Open Source Software

Last synced: 6 months ago · JSON representation

Repository

Bridging the gap between observation and theory

Basic Info

Host: GitHub
Owner: HeloiseS
License: bsd-3-clause
Language: Python
Default Branch: release
Homepage: https://heloises.github.io/hoki/intro.html
Size: 392 MB

Statistics

Stars: 49
Watchers: 5
Forks: 10
Open Issues: 13
Releases: 11

Created over 6 years ago · Last pushed 8 months ago

Metadata Files

Readme License

README.rst

.. image:: black_text.png
    :height: 35px
   
.. image:: https://img.shields.io/pypi/v/hoki?style=flat-square   
    :alt: PyPI
    
.. image:: https://zenodo.org/badge/197853216.svg
    :target: https://zenodo.org/badge/latestdoi/197853216
    
.. image:: https://github.com/HeloiseS/hoki/actions/workflows/ci_release.yml/badge.svg
    :target: https://github.com/HeloiseS/hoki/actions/workflows/ci_release.yml)
    
.. image:: https://img.shields.io/pypi/dm/hoki

**Note**: If you raise an issue and I ignore you please **email: hfstevance@gmail.com** (I probably just missed GitHub's email). 

Bridging the Gap Between Observation and Theory
=================================================

In order to facilitate the application of **BPASS** to a wide range of scientific investigations, we have developped the tools necessary for observers to take full advantage of our models in an intuitive manner. 

Hoki is not only versatile, it also takes care of the nitty gritty pre-processing!

**Spend less time on coding and more time on the science!**

**WHAT IS BPASS?**

   *The Binary Populations And Spectral Synthesis (BPASS) code simulates stellar populations and follows their evolution until death. Including binary evolution is crucial to correctly interpreting astronomical observations. The detailed follow-up of the stellar evolution within the code allows the retreival of important information such as supernova and gravitational wave event rates, giving us the ability to understand the properties of the stellar populations that are the precursors of these events.*

----
   
Installing hoki
^^^^^^^^^^^^^^^^^

You can pip install the **most recent stable release** from pip:

.. code-block:: none

   pip3 install --user hoki
   
You can also download the **github dev version** with the following command:

.. code-block:: none

   pip3 install . git+https://github.com/HeloiseS/hoki

If you install the development version of hoki from github, we recommend you do so in a `conda environment `_ 
To check that hoki is up and running you can run the unit tests in the test folder. I like using `pytest` (which you'll have to download) and run 

.. code-block:: none

   pytest --verbose

This way it'll show you each test as they pass or FAIL. In the pip and github version, they should all pass on your machine as data is provided within the package to test the functionalities.


**Requirements:** The following packages are required by `hoki`. If you pip install the stable version from pypi it will all be done automatically.

.. code-block:: none

   `astropy`, `numpy`, `scipy`, `pandas`, `matplotlib`, `pyyaml`, `wheel`, `emcee`, `corner`, `numba`, `specutils`, `ppxf`


Tested for python 3.7 and above. Python 2 not supported.

----

Read the docs
^^^^^^^^^^^^^^^


`Click Here! Click Here! Click Here! `_

----

Download Tutorials
^^^^^^^^^^^^^^^^^^^^

Check out these Jupyter notebooks I made - you can find them on `this repo! `__

---- 

Paper and how to cite us!
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: https://joss.theoj.org/papers/10.21105/joss.01987/status.svg
   :target: https://doi.org/10.21105/joss.01987
   
Our paper *Hoki: Making BPASS Accessible Through Python* has now been published in the Journal of Open Source Software (JOSS). (See DOI above)

The paper is `available on ArXiv `_ as published by JOSS

**Please if you use `hoki` for your science, include us in your publications!** As you can imagine developing a tool and maintaining it for the community is very time consuming, and unfortunatly citations remain the most important metric. 

If you use the following tools, please acknowledge the follwing publications:

**AgeWizard**:

.. image:: https://img.shields.io/badge/arxiv-2004.02883-red
   :target: https://arxiv.org/abs/2004.02883

**UnderlyingCountRatio**:

.. image:: https://img.shields.io/badge/arxiv-2004.13040-red
   :target: https://arxiv.org/abs/2004.13040

**BIBTEX**

.. code-block::

   @ARTICLE{2020JOSS....5.1987S,
       author = {{Stevance}, Heloise and {Eldridge}, J. and {Stanway}, Elizabeth},
        title = "{Hoki: Making BPASS accessible through Python}",
      journal = {The Journal of Open Source Software},
     keywords = {Python, galaxies, Batchfile, SED, astronomy, binary stars, Astrophysics - Solar and Stellar Astrophysics, Astrophysics - Astrophysics of Galaxies, Astrophysics - Instrumentation and Methods for Astrophysics},
         year = "2020",
        month = "Jan",
       volume = {5},
       number = {45},
          eid = {1987},
        pages = {1987},
          doi = {10.21105/joss.01987},
     archivePrefix = {arXiv},
       eprint = {2001.11069},
     primaryClass = {astro-ph.SR},
       adsurl = {https://ui.adsabs.harvard.edu/abs/2020JOSS....5.1987S},
      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
    }
     


---- 

License
^^^^^^^^^^^

This project is Copyright (c) H. F. Stevance and licensed under
the terms of the BSD 3-Clause license. This package is based upon
the `Astropy package template `_
which is licensed under the BSD 3-clause licence. 

----

Contributing
^^^^^^^^^^^^^^

If ANYTHING comes to mind, whether it be something in the tutorials, features you would like us to consider, BUGS, etc.. 
**Please just drop it in an issue! Don't let your imposter syndrome talk you out of it ;)**


.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
    :target: http://www.astropy.org
    :alt: Powered by Astropy Badge

Owner

Name: Heloise
Login: HeloiseS
Kind: user
Location: New Zealand
Company: University of Auckland

Website: hfstevance.com
Twitter: Sydonahi
Repositories: 4
Profile: https://github.com/HeloiseS

Research fellow at the University of Auckland! Lead developer of hoki. Writing software for me and for the community.

JOSS Publication

Hoki: Making BPASS accessible through Python

Published

January 29, 2020

DOI

10.21105/joss.01987

Volume 5, Issue 45, Page 1987

Authors

Heloise F. Stevance

Department of Physics, University of Auckland, New Zealand

J. J. Eldridge
Department of Physics, University of Auckland, New Zealand

Elizabeth Stanway
Department of Physics and Astronomy, University of Warwick, United Kingdom

Editor

Arfon Smith

GitHub Events

Total

Issues event: 1
Watch event: 1
Issue comment event: 2
Push event: 2
Fork event: 3

Last Year

Issues event: 1
Watch event: 1
Issue comment event: 2
Push event: 2
Fork event: 3

Committers

Last synced: 7 months ago

All Time

Total Commits: 550
Total Committers: 11
Avg Commits per committer: 50.0
Development Distribution Score (DDS): 0.218

Past Year

Commits: 0
Committers: 0
Avg Commits per committer: 0.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
heloises	h**w@g**m	430
Max Briel	m**l@a**z	66
Heloise	f**1@s**k	26
Martin Glatzle	m**e@m**e	8
findesgh	f**p@y**u	6
glebgeinke	6****e	4
Heloise	h**e@g**m	3
wjr21	w**1@s**k	2
Sean Richards	K****c	2
Heloise Stevance	h**e@g**m	2
Martin Glatzle	f**h@y**u	1

Committer Domains (Top 20 + Academic)

yandex.ru: 2 sussex.ac.uk: 1 mpa-garching.mpg.de: 1 sheffield.ac.uk: 1 auckland.ac.nz: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 64
Total pull requests: 40
Average time to close issues: about 1 month
Average time to close pull requests: 10 days
Total issue authors: 19
Total pull request authors: 6
Average comments per issue: 1.58
Average comments per pull request: 0.7
Merged pull requests: 36
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

View more stats

Top Authors

Issue Authors

RyotaInagaki1 (19)
HeloiseS (15)
Knusper (5)
maxbriel (4)
AlexandreLegault (3)
JJEldridge (2)
Krytic (2)
sunnc (2)
KshitijAggarwal (2)
J-Gleave (1)
findesgh (1)
aaltm (1)
WillJRoper (1)
Erin147 (1)
palfeng (1)

Pull Request Authors

HeloiseS (24)
findesgh (7)
maxbriel (6)
WillJRoper (2)
Krytic (1)
glebgeinke (1)

Top Labels

Issue Labels

bug (15) enhancement (12) documentation (10) good first issue (1)

Pull Request Labels

bug (3) enhancement (2)

Packages

Total packages: 1
Total downloads:
- pypi 107 last-month

Total dependent packages: 0
Total dependent repositories: 1
Total versions: 14
Total maintainers: 1

pypi.org: hoki

A Python interface to BPASS - Bridging the gap between observation and theory

Homepage: https://heloises.github.io/hoki/intro.html
Documentation: https://hoki.readthedocs.io/
License: BSD 3-Clause
Latest release: 1.7.1
published about 3 years ago

Versions: 14
Dependent Packages: 0
Dependent Repositories: 1
Downloads: 107 Last month

Rankings

Dependent packages count: 9.6%

Stargazers count: 10.0%

Forks count: 12.6%

Average: 15.9%

Dependent repos count: 21.9%

Downloads: 25.2%

Maintainers (1)

heloise

Last synced: 6 months ago

Dependencies

.github/workflows/testing.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite

.github/workflows/ci_all.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite

.github/workflows/ci_release.yml actions

actions/checkout v3 composite
actions/setup-python v3 composite

pyproject.toml pypi

setup.py pypi

Hoki

Science Score: 95.0%

Repository

Basic Info

Statistics

Metadata Files

README.rst

Owner

JOSS Publication

Hoki: Making BPASS accessible through Python

Authors

Editor

Tags

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

pypi.org: hoki

Rankings

Maintainers (1)

Dependencies