Package: wiserep-api
WiseRep APIAPI to access WiserRep data from command linesInstallationIt is recommended to installwiserep_apifrom pip:pipinstallwiserep_apior it can be installed from source in the usual way.Usage ExampleBelow are some basic examples of what the user can do with this package.Download a list of SNeA list of targets can be downloaded for a given spectral type. The spectral types are as defined in Wiserep, which can be printed withprint_spectral_types:fromwiserep_api.searchimportprint_spectral_types,download_sn_listprint_spectral_types(){'Other':0,'SN':1,'SN I':2,'SN Ia':3,'SN Ib':4,'SN Ic':5,'SN Ib/c':6,'SN Ic-BL':7,'SN Ib - Ca-rich':8,'SN Ibn':9,'SN II':10,'SN IIP':11,'SN IIL':12,'SN IIn':13,'SN IIb':14,'SN I-faint':15,'SN I-rapid':16,'SLSN-I':18,'SLSN-II':19,'SLSN-R':20,'Afterglow':23,'LBV':24,'ILRT':25,'Nova':26,'CV':27,'Varstar':28,'AGN':29,'Galaxy':30,'QSO':31,'Std-spec':50,'Gap':60,'Gap I':61,'Gap II':62,'SN impostor':99,'SN Ia-pec':100,'SN Ia-SC':102,'SN Ia-91bg-like':103,'SN Ia-91T-like':104,'SN Ia-02cx-like':105,'SN Ia-CSM':106,'SN Ib-pec':107,'SN Ic-pec':108,'SN II-pec':110,'SN IIn-pec':112,'TDE':120,'WR':200,'WR-WN':201,'WR-WC':202,'WR-WO':203,'M dwarf':210}In this example, we can download 1991-T-like supernovae (SNe):download_sn_list("SN Ia-91T-like")390"SN Ia-91T-like"objectsfound!URLused:https://www.wiserep.org/search?&page=8&public=all&type[]=104Download spectraThe public available spectra can also be easily downloaded for a list of targets. These will be saved under thespectradirectory, in a separate directory for each target:importnumpyasnpfromwiserep_apiimportdownload_target_spectrasne_list=np.genfromtxt('SNIa-91T-like_wiserep.txt',dtype=str,delimiter='\n')forsninsne_list:try:download_target_spectra(sn,file_type='ascii',exclude=['SEDM'])exceptExceptionasexc:print(f'{sn}:{exc}')Running SNIDAssuming thatSNIDis already istalled, it can be run with just a few lines of code:importosfromwiserep_apiimportsnidsne_list=np.genfromtxt('SNIa-91T-like_wiserep.txt',dtype=str,delimiter='\n')snid_commmand='snid inter=0 plot=0 aband=0 usetype=Ia-91T'forsninsne_list:directory=os.path.join('spectra',sn)snid.run_snid(directory,command=snid_commmand)Getting object's propertiesThe properties of a given object can be easily obtained:fromwiserep_apiimportget_target_propertyforpropin['type','redshift','host','coords','coords_deg']:value=get_target_property('2004eo',prop)print(f'{prop}:{value}')type:SNIaredshift:0.015718host:NGC6928coords:20:32:54.190+09:55:42.71coords_deg:308.22579+9.92853Or you can get multiple properties at once:properties=['type','redshift','host','coords','coords_deg']values=get_target_property('2004eo',properties)The spectral type of a given object can also be retrived withget_target_class, which does a more "in-depth" search of the classification in case this is not found in the main properties:fromwiserep_apiimportget_target_classsn_type=get_target_class("2004eo")print(sn_type)'SN Ia'ContributingTo contribute, either open an issue or send a pull request (prefered option). You can also contact me directly (check my profile:https://github.com/temuller).Citing WiseRep APIIf you make use of this code, please cite it:@software{tomas_e_muller_bravo_2023_7896352,
  author       = {{M{\"u}ller-Bravo}, Tom{\'a}s E.},
  title        = {temuller/wiserep\_api: First Official Release!},
  month        = may,
  year         = 2023,
  publisher    = {Zenodo},
  version      = {v0.1.5},
  doi          = {10.5281/zenodo.7896352},
  url          = {https://doi.org/10.5281/zenodo.7896352}
}