species.core package

Submodules

species.core.box module

Module with the Box classes and create_box function.

class species.core.box.Box[source]

Bases: object

Class for generic methods that can be applied on all Box object.

Returns:

None

Return type:

NoneType

open_box()[source]

Method for inspecting the content of a Box.

Returns:

None

Return type:

NoneType

class species.core.box.ColorColorBox[source]

Bases: Box

Class for storing color-color data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.ColorMagBox[source]

Bases: Box

Class for storing color-magnitude data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.CoolingBox[source]

Bases: Box

Class for storing cooling curve data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.IsochroneBox[source]

Bases: Box

Class for storing isochrone data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.ModelBox[source]

Bases: Box

Class for storing a model spectrum in a Box.

Returns:

None

Return type:

NoneType

resample_spectrum(wavel_resample: ndarray) → None[source]

Method for resampling the spectrum with spectres to a new wavelength grid.

Parameters:

wavel_resample (np.ndarray) – Wavelength points (um) to which the spectrum will be resampled.

Returns:

None

Return type:

NoneType

smooth_spectrum(spec_res: float) → None[source]

Method for smoothing the spectrum with a Gaussian kernel to the instrument resolution. The method is best applied on an input spectrum with a logarithmic wavelength sampling (i.e. constant spectral resolution). Alternatively, the wavelength sampling may be linear, but the smoothing is slower in that case.

Parameters:

spec_res (float) – Spectral resolution that is used for the smoothing kernel.

Returns:

None

Return type:

NoneType

synthetic_photometry(filter_name: str | list[str]) → PhotometryBox[source]

Method for calculating synthetic photometry from the model spectrum that is stored in the ModelBox.

Parameters:

filter_name (str, list(str)) – Single filter name or a list of filter names for which synthetic photometry will be calculated.

Returns:

Box with the synthetic photometry.

Return type:

species.core.box.PhotometryBox

class species.core.box.ObjectBox[source]

Bases: Box

Class for storing object data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.PhotometryBox[source]

Bases: Box

Class for storing photometric data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.ResidualsBox[source]

Bases: Box

Class for storing best-fit residuals in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.SamplesBox[source]

Bases: Box

Class for storing posterior samples in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.SpectrumBox[source]

Bases: Box

Class for storing spectral data in a Box.

Returns:

None

Return type:

NoneType

class species.core.box.SynphotBox[source]

Bases: Box

Class for storing synthetic photometry in a Box.

Returns:

None

Return type:

NoneType

species.core.box.create_box(boxtype, **kwargs)[source]

Function for creating a Box.

Returns:

Box with the data and parameters.

Return type:

species.core.box

species.core.constants module

Physical constants in the International System of Units (SI).

species.core.species_init module

Module for setting up species in the working folder.

class species.core.species_init.SpeciesInit(config_file: str | PosixPath | WindowsPath | None = None, database_file: str | PosixPath | WindowsPath | None = None)[source]

Bases: object

Class for initiating species by creating the database and configuration file in case they are not present in the working folder, and creating the data folder for storage of input data.

Parameters:

  • config_file (str, PosixPath, WindowsPath, None) – Path to the configuration file that is stored as species_config.ini. Setting the argument enables reading a configuration file at a different path than the current working directory. The default location (i.e. the working folder of your script or notebook) is used by setting the argument to None.

  • database_file (str, PosixPath, WindowsPath, None) – Path to the HDF5 database that is stored as species_database.hdf5. Setting the argument will overwrite the database path in the configuration file. The path from the configuration file is used if the argument of database_file is set to None.

Returns:

None

Return type:

NoneType

Module contents