Package: astrostarfish
StarfishStarfishis a set of tools used for spectroscopic inference. We designed the package to robustly determine stellar parameters using high resolution spectral models.Warning!There have been major, breaking updates since version0.2.0, please seethis pageregarding these changes if you are used to the old version!CitationsIf you use this code or derivative components of this code in your research, please cite ourpaperas well as thecode. SeeCITATION.bibfor a BibTeX formatted reference of this work.PapersCzekala et al. 2015Gully-Santiago et al. 2017Greene et al. 2018Zhang et al. 2021bZhang et al. 2021cIf you have used Starfish in your work, please let us know and we can add you to this list!Please bear in mind that this package is under heavy development and features may evolve rapidly. If something doesn't work, please fill anissueon 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!Installation InstructionsPrerequisitesStarfishhas several dependencies, however most of them should be satisfied by an up-to-date scientific python installation. We highly recommend using theAnaconda Scientific Python Distributionand updating to
Python 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.To make sure you are running the correct version of python, start a python interpreter via the system shell and you should see something similar$ python
Python 3.6.1 |Anaconda custom (64-bit)| (default, May 11 2017, 13:25:24) [MSC v.1900 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>>If your shell says Python 2.x, try using thepython3command instead ofpython.InstallationFor the most current stable release ofStarfish, use the releases from PyPI$ pip install astrostarfishIf you want to be on the most up-to-date version (or a development version), install from source via$ pip install git+https://github.com/iancze/Starfish.git#egg=astrostarfishTo test that you've properly installedStarfish, try doing the following inside of a Python interpreter session>>>importStarfish>>>Starfish.__version__'0.3.0'If you see any errors, then something went wrong--please file anissue.Now that you've successfully installed the code, please see thedocumentationon how to begin usingStarfishto solve your spectroscopic inference problem.ContributingIf you are interested in contributing toStarfish, first off, thank you! We appreciate your time and effort into
making our project better. To get set up in a development environment, it is highly recommended to develop in a
virtual environment. We usepipenv(pending a better PEP 517/518 compliant tool) to manage our environments, to get started clone the repository (and we recommend forking us first)$ git clone https://github.com/<your_fork>/Starfish.git starfish
$ cd starfishand then create the virtual environment and install all the packages and developer dependencies from thePipfilewith$ pipenv install -dand to enter the virtual environment, simply issue$ pipenv shellwhenever you're in thestarfishfolder.We also enforce theblackcode style. This tools allows automatically formatting everything for you, which is much easier than caring about it yourself! We have apre-commithook that willblackenyour 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$ pipenv run pre-commit installFrom then on, any commits will format your code before succeeding!Take a look through theissuesif you are looking for a place to start improvingStarfish!TestsWe usepytestfor testing; within the virtual environment$ pytestNote that we use theblackcode style and our CI testing will check that everything is formatted correctly. To check your code$ pytest --blackalthough if you follow the instructions for usingpre-commityou should have no issues.ContributorsSeeCONTRIBUTORS.mdfor a full list of contributors.