Skip to content

jaladh-singhal/starkit

 
 

Repository files navigation

StarKit

image

Installation

We recommend you use Anaconda to install the necessary requirements for Starkit to work.

Once you have anaconda installed please make a new environment with the prerequisites for starkit in the following way. This will create an environment called `starkit`:

curl -O https://raw.githubusercontent.com/starkit/starkit/master/starkit_env3.yml

# install using yml file into an environment called starkit. 
# If you want to call it something else, or already have a starkit enivornment, 
# you can change the -n argument

conda env create --file starkit_env3.yml -n starkit
source activate starkit

For now until a new version of Astropy comes out that fixes some problems of memory leak, you need to install specutils from our fork:

git clone https://github.com/followthesheep/specutils
cd specutils
python setup.py install

Then you can additionally install any other packages you like with:

conda install <your package>

Once this is installed, there are two ways to install starkit. For simple use:

pip install git+https://github.com/starkit/starkit

To download a full development version of starkit, please do:

git clone https://github.com/starkit/starkit
cd starkit
python setup.py develop

Example publications that use StarKit

A few test grids can be found at https://starkit.github.io/starkit/io/available_grids.html. If you use any of these grids, please make sure that the grid from which it is created (like Phoenix grid) is also cited.

Packages

No packages published

Languages

  • Python 76.9%
  • Jupyter Notebook 22.4%
  • Shell 0.7%