{"id":13771431,"url":"https://github.com/Starfish-develop/Starfish","last_synced_at":"2025-05-11T04:30:46.349Z","repository":{"id":9688463,"uuid":"11635122","full_name":"Starfish-develop/Starfish","owner":"Starfish-develop","description":"Tools for Flexible Spectroscopic Inference","archived":false,"fork":false,"pushed_at":"2023-03-17T20:03:11.000Z","size":310631,"stargazers_count":67,"open_issues_count":30,"forks_count":22,"subscribers_count":12,"default_branch":"master","last_synced_at":"2024-05-23T03:31:05.181Z","etag":null,"topics":["astronomy","astrophysics","inference","mcmc","python","spectra","starfish"],"latest_commit_sha":null,"homepage":"https://starfish.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Starfish-develop.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.bib","codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2013-07-24T13:14:29.000Z","updated_at":"2024-04-28T22:45:34.000Z","dependencies_parsed_at":"2022-09-21T13:51:57.709Z","dependency_job_id":null,"html_url":"https://github.com/Starfish-develop/Starfish","commit_stats":{"total_commits":1366,"total_committers":13,"mean_commits":"105.07692307692308","dds":0.4165446559297218,"last_synced_commit":"6b20086f85ed92332543a2b30dfd56e851d593a4"},"previous_names":["iancze/starfish"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starfish-develop%2FStarfish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starfish-develop%2FStarfish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starfish-develop%2FStarfish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Starfish-develop%2FStarfish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Starfish-develop","download_url":"https://codeload.github.com/Starfish-develop/Starfish/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253518941,"owners_count":21921074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["astronomy","astrophysics","inference","mcmc","python","spectra","starfish"],"created_at":"2024-08-03T17:00:51.426Z","updated_at":"2025-05-11T04:30:41.705Z","avatar_url":"https://github.com/Starfish-develop.png","language":"Python","funding_links":[],"categories":["Spectral inference"],"sub_categories":[],"readme":"# Starfish\n[![Documentation Status](https://readthedocs.org/projects/starfish/badge/?version=latest)](https://starfish.readthedocs.io/en/latest/?badge=latest)\n[![Build Status](https://github.com/iancze/Starfish/workflows/CI/badge.svg?branch=master)](https://github.com/iancze/Starfish/actions)\n[![Coverage Status](https://codecov.io/gh/iancze/Starfish/graph/badge.svg)](https://codecov.io/gh/iancze/Starfish/)\n[![PyPI](https://img.shields.io/pypi/v/astrostarfish.svg)](https://pypi.org/project/astrostarfish/)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2221005.svg)](https://doi.org/10.5281/zenodo.2221005)\n\n*Starfish* is a set of tools used for spectroscopic inference. We designed the package to robustly determine stellar parameters using high resolution spectral models.\n\n**Warning!**\n\nThere have been major, breaking updates since version `0.2.0`, please see [this page](https://starfish.readthedocs.io/en/latest/conversion.html) regarding these changes if you are used to the old version!\n\n### Citations\n\nIf you use this code or derivative components of this code in your research, please cite our [paper](https://ui.adsabs.harvard.edu/abs/2015ApJ...812..128C/abstract) as well as the [code](https://doi.org/10.5281/zenodo.2221006). See [`CITATION.bib`](CITATION.bib) for a BibTeX formatted reference of this work.\n\n### Papers\n* [Czekala et al. 2015](https://ui.adsabs.harvard.edu/#abs/2015ApJ...812..128C/abstract)\n* [Gully-Santiago et al. 2017](https://ui.adsabs.harvard.edu/#abs/2017ApJ...836..200G/abstract)\n* [Greene et al. 2018](https://ui.adsabs.harvard.edu/abs/2018ApJ...862...85G/abstract)\n* [Zhang et al. 2021b](https://ui.adsabs.harvard.edu/abs/2020arXiv201112294Z/abstract)\n* [Zhang et al. 2021c](https://ui.adsabs.harvard.edu/abs/2021arXiv210505256Z/abstract)\n\n*If you have used Starfish in your work, please let us know and we can add you to this list!*\n\nPlease bear in mind that this package is under heavy development and features may evolve rapidly. If something doesn't work, please fill an [issue](https://github.com/iancze/Starfish/issues) on this repository. If you would like to contribute to this project (either with bugfixes, documentation, or new features) please feel free to fork the repository and submit a pull request!\n\n# Installation Instructions\n\n## Prerequisites\n\n*Starfish* has several dependencies, however most of them should be satisfied by an up-to-date scientific python installation. We highly recommend using the [Anaconda Scientific Python Distribution](https://store.continuum.io/cshop/anaconda/) and updating to \nPython 3.6 or greater. This code makes no attempt to work on the Python 2.x series, and I doubt it will if you try. This package is tested across Linux, Mac OS X, and Windows. \n\nTo make sure you are running the correct version of python, start a python interpreter via the system shell and you should see something similar\n\n    $ python\n    Python 3.6.1 |Anaconda custom (64-bit)| (default, May 11 2017, 13:25:24) [MSC v.1900 64 bit (AMD64)] on win32\n    Type \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n    \u003e\u003e\u003e \n\nIf your shell says Python 2.x, try using the `python3` command instead of `python`.\n\n## Installation\n\nFor the most current stable release of *Starfish*, use the releases from PyPI\n\n    $ pip install astrostarfish\n\nIf you want to be on the most up-to-date version (or a development version), install from source via\n\n    $ pip install git+https://github.com/iancze/Starfish.git#egg=astrostarfish\n\n\nTo test that you've properly installed *Starfish*, try doing the following inside of a Python interpreter session\n\n```python\n\u003e\u003e\u003e import Starfish\n\u003e\u003e\u003e Starfish.__version__\n'0.3.0'\n```\n\nIf you see any errors, then something went wrong--please file an [issue](https://github.com/iancze/Starfish/issues).\n\nNow that you've successfully installed the code, please see the [documentation](https://starfish.readthedocs.io/en/latest/) on how to begin using *Starfish* to solve your spectroscopic inference problem.\n\n# Contributing\nIf you are interested in contributing to *Starfish*, first off, thank you! We appreciate your time and effort into\nmaking our project better. To get set up in a development environment, it is highly recommended to develop in a\nvirtual environment. We use `pipenv` (pending a better PEP 517/518 compliant tool) to manage our environments, to get started clone the repository (and we recommend forking us first)\n\n    $ git clone https://github.com/\u003cyour_fork\u003e/Starfish.git starfish\n    $ cd starfish\n\nand then create the virtual environment and install all the packages and developer dependencies from the `Pipfile` with\n\n    $ pipenv install -d\n\nand to enter the virtual environment, simply issue\n\n    $ pipenv shell\n\nwhenever you're in the `starfish` folder.\n\nWe also enforce the `black` [code style](https://github.com/python/black). This tools allows automatically formatting everything for you, which is much easier than caring about it yourself! We have a [pre-commit](https://pre-commit.com/) hook that will *blacken* your code before you commit so you can avoid failing the CI tests because you forgot to format. To use this, just install the hook with \n\n    $ pipenv run pre-commit install\n\nFrom then on, any commits will format your code before succeeding!\n\nTake a look through the [issues](https://github.com/iancze/Starfish/issues) if you are looking for a place to start improving *Starfish*!\n\n**Tests**\n\nWe use `pytest` for testing; within the virtual environment\n\n    $ pytest\n\nNote that we use the `black` code style and our CI testing will check that everything is formatted correctly. To check your code\n\n    $ pytest --black\n\nalthough if you follow the instructions for using *pre-commit* you should have no issues.\n\n\n## Contributors\n\nSee [`CONTRIBUTORS.md`](CONTRIBUTORS.md) for a full list of contributors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStarfish-develop%2FStarfish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStarfish-develop%2FStarfish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStarfish-develop%2FStarfish/lists"}