Skip to content

Releases: giganano/VICE

v1.3.1

25 Oct 22:44
Compare
Choose a tag to compare

Changelog entries for this release:

1.3.1

  • vice.multizone
    Enforces each zone to run in the same mode (related to the handling of
    inflow metallicites; see below).

  • vice.singlezone and vice.multizone

    • Handles non-zero inflow metallicities in a more stable way. Unit tests
      search for numerical artifacts in "sudden event" evolutionary histories
      exhibiting bursts in star formation.

    • Includes primordial metallicity component in the reported total abundance
      in accreting gas at each timestep.

  • vice.dataframe
    Fixed issues with inheritance structure affecting recent versions of
    python (3.11 and 3.12)

  • vice.yields.ccsne.fractional

    • Subtracts the remnant mass from the initial mass in computing net yields
      from the tables containing gross yields. A small correction for metals,
      the difference is significant for helium.
  • Fixed callback objects to be compatible with Cython>=3.0.

v1.3.0

11 Feb 02:13
Compare
Choose a tag to compare

Changelog entries for this release:

1.3.0

  • vice.mlr
    Additional options for the stellar mass-lifetime relation (MLR).

    • vice.mlr.powerlaw : function
      The single power-law formulation assumed in previous versions.

    • vice.mlr.vincenzo2016 : function
      The MLR parameterized by Vincenzo et al. (2016), MNRAS, 460, 2238

    • vice.mlr.hpt2000 : function
      The MLR parameterized by Hurley, Pols & Tout (2000), MNRAS, 315, 543

    • vice.mlr.ka1997 : function
      The MLR parameterized by Kodama & Arimoto (1997), A&A, 320, 41

    • vice.mlr.pm1993 : function
      The MLR parameterized by Padovani & Matteucci (1993), ApJ, 416, 26

    • vice.mlr.mm1989 : function
      The MLR parameterized by Maeder & Meynet (1989), A&A, 210, 155

    • vice.mlr.larson1974 : function
      The MLR parameterized by Larson (1974), MNRAS, 166, 585

    • vice.mlr.setting : str
      A string denoting which of the above functions to adopt as the current
      setting determining the MLR in all chemical evolution models and
      single stellar population calculations.

    • vice.mlr.recognized : tuple
      Contains the strings denoting allowed values for vice.mlr.setting.

  • vice.yields.agb.ventura13
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from the following set of papers:

    • Ventura et al. (2013), MNRAS, 431, 3642 (Z = 0.0003, 0.008)
    • Ventura et al. (2014), MNRAS, 437, 3274 (Z = 0.004)
    • Ventura et al. (2018), MNRAS, 475, 2282 (Z = 0.014)
    • Ventura et al. (2020), A&A, 641, A103 (Z = 0.04)

    These tables also include unpublished yields from the same author at
    progenitor metallicities of Z = 0.001 and 0.002.

  • vice.yields.agb.karakas16
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from Karakas & Lugaro (2016), ApJ, 825, 26 and Karakas et al.
    (2018), MNRAS, 477, 421. The Karakas & Lugaro (2016) tables provide yields
    for progenitor metallicities of Z = 0.007, 0.014, and 0.03, while the
    Karakas et al. (2018) tables provide them for Z = 0.0028, a metallicity
    appropriate for stars in the Small Magellanic Cloud.

  • vice.yields.sneia.gronow21
    New set of theoretically predicted type Ia supernova yields compiled from
    Gronow et al. (2021a), A&A, 649, 155 and Gronow et al. (2021b),
    arxiv:2103.14050. These studies report yields for double detonations of
    sub-Chandrasekhar mass white dwarfs at various progenitor metallicities.
    The Gronow et al. (2021a) study reports yields for white dwarf progenitors
    of solar metallicity, while Gronow et al. (2021b) report them for
    Z / Zsun = 0.01, 0.1, and 3.

  • vice.primordial
    Primordial abundance of helium updated from 0.24672 to 0.24721 based on the
    findings of Pitrou et al. (2021), MNRAS, 502, 2474.

  • Command-Line Functionality
    When running vice --tutorial from the command line (or equivalently,
    python -m vice --tutorial), VICE first attempts to download the
    examples/QuickStartTutorial.ipynb jupyter notebook to the install directory,
    and then launches it locally. If it cannot download the notebook, it will
    launch a previously downloaded version if it has one. In the event that no
    local copy exists and it cannot be downloaded, it will raise a
    RuntimeError.

Patches

  • Addressed single timestep level bug in elemental accretion rate from
    primordial gas affecting models ran in star formation and gas modes.

Version 1.3.0rc2

14 Jan 19:57
Compare
Choose a tag to compare
Version 1.3.0rc2 Pre-release
Pre-release

This is the second pre-release of version 1.3.0. Changelog entries for this release:

1.3.0

  • vice.mlr
    Additional options for the stellar mass-lifetime relation (MLR).

    • vice.mlr.powerlaw : function
      The single power-law formulation assumed in previous versions.

    • vice.mlr.vincenzo2016 : function
      The MLR parameterized by Vincenzo et al. (2016), MNRAS, 460, 2238

    • vice.mlr.hpt2000 : function
      The MLR parameterized by Hurley, Pols & Tout (2000), MNRAS, 315, 543

    • vice.mlr.ka1997 : function
      The MLR parameterized by Kodama & Arimoto (1997), A&A, 320, 41

    • vice.mlr.pm1993 : function
      The MLR parameterized by Padovani & Matteucci (1993), ApJ, 416, 26

    • vice.mlr.mm1989 : function
      The MLR parameterized by Maeder & Meynet (1989), A&A, 210, 155

    • vice.mlr.larson1974 : function
      The MLR parameterized by Larson (1974), MNRAS, 166, 585

    • vice.mlr.setting : str
      A string denoting which of the above functions to adopt as the current
      setting determining the MLR in all chemical evolution models and
      single stellar population calculations.

    • vice.mlr.recognized : tuple
      Contains the strings denoting allowed values for vice.mlr.setting.

  • vice.yields.agb.ventura13
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from the following set of papers:

    • Ventura et al. (2013), MNRAS, 431, 3642 (Z = 0.0003, 0.008)
    • Ventura et al. (2014), MNRAS, 437, 3274 (Z = 0.004)
    • Ventura et al. (2018), MNRAS, 475, 2282 (Z = 0.014)
    • Ventura et al. (2020), A&A, 641, A103 (Z = 0.04)

    These tables also include unpublished yields from the same author at
    progenitor metallicities of Z = 0.001 and 0.002.

  • vice.yields.agb.karakas16
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from Karakas & Lugaro (2016), ApJ, 825, 26 and Karakas et al.
    (2018), MNRAS, 477, 421. The Karakas & Lugaro (2016) tables provide yields
    for progenitor metallicities of Z = 0.007, 0.014, and 0.03, while the
    Karakas et al. (2018) tables provide them for Z = 0.0028, a metallicity
    appropriate for stars in the Small Magellanic Cloud.

  • vice.yields.sneia.gronow21
    New set of theoretically predicted type Ia supernova yields compiled from
    Gronow et al. (2021a), A&A, 649, 155 and Gronow et al. (2021b),
    arxiv:2103.14050. These studies report yields for double detonations of
    sub-Chandrasekhar mass white dwarfs at various progenitor metallicities.
    The Gronow et al. (2021a) study reports yields for white dwarf progenitors
    of solar metallicity, while Gronow et al. (2021b) report them for
    Z / Zsun = 0.01, 0.1, and 3.

  • vice.primordial
    Primordial abundance of helium updated from 0.24672 to 0.24721 based on the
    findings of Pitrou et al. (2021), MNRAS, 502, 2474.

  • Command-Line Functionality
    When running vice --tutorial from the command line (or equivalently,
    python -m vice --tutorial), VICE first attempts to download the
    examples/QuickStartTutorial.ipynb jupyter notebook to the install directory,
    and then launches it locally. If it cannot download the notebook, it will
    launch a previously downloaded version if it has one. In the event that no
    local copy exists and it cannot be downloaded, it will raise a
    RuntimeError.

Patches

  • Addressed single timestep level bug in elemental accretion rate from
    primordial gas affecting models ran in star formation and gas modes.

Version 1.3.0rc1

25 Oct 16:23
Compare
Choose a tag to compare
Version 1.3.0rc1 Pre-release
Pre-release

This is the first pre-release of version 1.3.0. Changelog entries for this release:

1.3.0

  • vice.mlr
    Additional options for the stellar mass-lifetime relation (MLR).

    • vice.mlr.powerlaw : function
      The single power-law formulation assumed in previous versions.

    • vice.mlr.vincenzo2016 : function
      The MLR parameterized by Vincenzo et al. (2016), MNRAS, 460, 2238

    • vice.mlr.hpt2000 : function
      The MLR parameterized by Hurley, Pols & Tout (2000), MNRAS, 315, 543

    • vice.mlr.ka1997 : function
      The MLR parameterized by Kodama & Arimoto (1997), A&A, 320, 41

    • vice.mlr.pm1993 : function
      The MLR parameterized by Padovani & Matteucci (1993), ApJ, 416, 26

    • vice.mlr.mm1989 : function
      The MLR parameterized by Maeder & Meynet (1989), A&A, 210, 155

    • vice.mlr.larson1974 : function
      The MLR parameterized by Larson (1974), MNRAS, 166, 585

    • vice.mlr.setting : str
      A string denoting which of the above functions to adopt as the current
      setting determining the MLR in all chemical evolution models and
      single stellar population calculations.

    • vice.mlr.recognized : tuple
      Contains the strings denoting allowed values for vice.mlr.setting.

  • vice.yields.agb.ventura13
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from the following set of papers:

    • Ventura et al. (2013), MNRAS, 431, 3642 (Z = 0.0003, 0.008)
    • Ventura et al. (2014), MNRAS, 437, 3274 (Z = 0.004)
    • Ventura et al. (2018), MNRAS, 475, 2282 (Z = 0.014)
    • Ventura et al. (2020), A&A, 641, A103 (Z = 0.04)

    These tables also include unpublished yields from the same author at
    progenitor metallicities of Z = 0.001 and 0.002.

  • vice.yields.agb.karakas16
    New set of theoretically predicted asymptotic giant branch star yields
    compiled from Karakas & Lugaro (2016), ApJ, 825, 26 and Karakas et al.
    (2018), MNRAS, 477, 421. The Karakas & Lugaro (2016) tables provide yields
    for progenitor metallicities of Z = 0.007, 0.014, and 0.03, while the
    Karakas et al. (2018) tables provide them for Z = 0.0028, a metallicity
    appropriate for stars in the Small Magellanic Cloud.

  • vice.yields.sneia.gronow21
    New set of theoretically predicted type Ia supernova yields compiled from
    Gronow et al. (2021a), A&A, 649, 155 and Gronow et al. (2021b),
    arxiv:2103.14050. These studies report yields for double detonations of
    sub-Chandrasekhar mass white dwarfs at various progenitor metallicities.
    The Gronow et al. (2021a) study reports yields for white dwarf progenitors
    of solar metallicity, while Gronow et al. (2021b) report them for
    Z / Zsun = 0.01, 0.1, and 3.

  • Command-Line Functionality
    When running vice --tutorial from the command line (or equivalently,
    python -m vice --tutorial), VICE first attempts to download the
    examples/QuickStartTutorial.ipynb jupyter notebook to the install directory,
    and then launches it locally. If it cannot download the notebook, it will
    launch a previously downloaded version if it has one. In the event that no
    local copy exists and it cannot be downloaded, it will raise a
    RuntimeError.

Version 1.2.1

18 Jun 21:16
Compare
Choose a tag to compare

Changelog entries for this release:

1.2.1

  • Minor documentation updates

Patches

  • Addressed spurrious warning regarding NaN main sequence turnoff mass

  • vice.dataframe.todict()
    Now returns a copy of the dictionary stored under the hood

Version 1.2.0

17 Mar 19:40
Compare
Choose a tag to compare

Changelog entries for this version:

1.2.0

  • vice.solar_z : dataframe
    Users may now modify their adopted solar composition.

    • vice.solar_z.epsilon_to_z_conversion : staticmethod
      New in this version.
      Converts number density relative to hydrogen to a mass fraction within
      the sun.

    • vice.elements.element.solar_z
      Now allows assignment.
      Accesing and modifying a given element's solar abundance via
      vice.solar_z is equivalent to going through the vice.elements
      module.

    • vice.elements.yield.agb
      New in this version.
      Accessing and modifying a given element's asymptotic giant branch star
      yield via vice.yields.agb.settings is equivalent to going through
      the vice.elements module.

  • vice.single_stellar_population : function
    Keyword argument "agb_model" deprecated, instead adopts the global
    asymptotic giant branch star yield.

  • vice.yields.agb.settings : dataframe
    New in this version.
    Users modify their adopted AGB star yields through a global setting,
    similar to their supernova yields, rather than specifying keyword arguments
    to functions and objects.
    Entries can be a function of progenitor stellar mass and metallicity, in
    that order, or a keyword denoting a built-in table of yields as in previous
    versions.

  • vice.yields.agb.interpolator : object
    New in this version.
    Conducts bi-linear interpolation of the asymptotic giant branch star
    yields sampled on a grid of masses and metallicities reported by a given
    study. Can be adopted as the global yield setting.

  • vice.yields.ccsne.fractional : function
    Keyword "IMF" can now be a user-defined function of stellar mass.
    New keyword arguments: "explodability", "wind", "net":

      - ``"explodability"`` : The fraction of stars which produce a core 
        collapse supernova event as a function of progenitor zero age main 
        sequence mass. 
      - ``"wind"`` : Whether or not to include stellar winds in the yield 
        calculation. 
      - ``"net"`` : Whether or not to compute a net yield, otherwise 
        computing gross yields. 
    
  • vice.yields.ccsne.table : function
    New in this version.
    Reads in the table of progenitor masses and mass yields published in a
    given nucleosynthesis study. Will return the full isotopic breakdown if
    requested.

  • vice.yields.ccsne.engines : module
    New in this version.
    Contains popular built-in forms of black hole landscapes, both simple and
    complex. They can be adopted as the keyword argument "explodability" to
    the vice.yields.ccsne.fractional function.

    • vice.yields.ccsne.engines.engine : object
      Base class.

    • vice.yields.ccsne.engines.cutoff : engine
      Only stars up to some user-defined progenitor mass explode.

    • vice.yields.ccsne.engines.E16 : engine
      Implements the Ertl et al. (2016) black hole landscape and variations
      thereof.

    • vice.yields.ccsne.engines.S16 : module
      Module containing black hole landscapes computed in Sukhbold et al.
      (2016). The engines "N20", "S19p8", "W15", "W18", and "W20" are
      included with the same name as in the journal publication, with
      "S19p8" being an adaptation of "S19.8":

      • vice.yields.ccsne.engines.S16.N20 : engine
      • vice.yields.ccsne.engines.S16.S19p8 : engine
      • vice.yields.ccsne.engines.S16.W15 : engine
      • vice.yields.ccsne.engines.S16.W18 : engine
      • vice.yields.ccsne.engines.S16.W20 : engine
  • vice.yields.ccsne.NKT13 : module
    New in this version.
    Nomoto, Kobayashi & Tominaga (2013) core collapse supernova yield tables.

  • vice.yields.ccsne.S16 : module
    New in this version.
    Sukhbold et al. (2016) nucleosynthetic yield tables.

    • vice.yields.ccsne.S16.N20 : module
      Sukhbold et al. (2016) mass yield tables computed under the N20
      explosion engine.

    • vice.yields.ccsne.S16.W18 : module
      Sukhbold et al. (2016) mass yield tables computed under the W18
      explosion engine.

    • vice.yields.ccsne.S16.W18F : module
      Sukhbold et al. (2016) mass yield tables computed under the W18
      explosion engine, forcing explosions in the model stars which otherwise
      would not have done so.

  • vice.yields.sneia.settings : dataframe
    Now allows entries to be a function of progenitor metallicity.

  • vice.singlezone.IMF : property
    Now allows functions of stellar mass.

  • vice.singlezone.tau_star : property
    Now allows functions accepting two parameters as well as those accepting
    only one.

  • vice.singlezone.agb_model : property
    Deprecated in this version.

  • vice.multizone : object
    New in this version.
    Runs multi-zone GCE simulations within a highly flexible framework.

  • vice.milkyway : multizone
    New in this version.
    A subclass of the multizone object optimized for modeling
    Milky Way-like galaxies.

  • vice.migration : module
    New in this version.
    Provides a means with which to declare migration prescriptions for use in
    multizone models.

  • vice.output.agb_yields : property
    New in this version.
    Provides a snapshot of the global AGB star yield settings at the time an
    output was computed from a singlezone object.

  • vice.multioutput : object
    New in this version.
    Handles output from the multizone object.

  • vice.stars : function
    New in this version.
    Reads in the data containing the masses, abundances, and initial and final
    zone numbers of individual stellar populations from a multizone
    object's output.

  • vice.toolkit : module
    New in this version.
    Generally useful utilities.

    • vice.toolkit.hydrodisk : module
      Built-in stellar radial migration schema informed by hydrodynamical
      simulations.

      • vice.toolkit.hydrodisk.hydrodiskstars : object
        A stellar migration prescription based on star particles from a
        hydrodynamical simulation.
        Requires supplemental data available online which VICE will
        download automatically.
    • vice.toolkit.J21_sf_law : object
      A star formation law which implements the observationally motivated
      parameterization in Johnson et al. (2021) and variations thereof.

    • vice.toolkit.interpolation : module
      Interpolation schema.

      • vice.toolkit.interpolation.interp_scheme_1d : object
        1-dimensional interpolation scheme.

      • vice.toolkit.interpolation.interp_scheme_2d : object
        2-dimensional interpolation scheme.

Version 1.1.0

14 Jun 21:41
Compare
Choose a tag to compare

Changelog entries for this version:

New

  • Updated source code for Johnson & Weinberg (2020) figures following peer
    review.

  • New chemical element: helium (he)

  • vice.primordial : dataframe
    Mapping from elements to their abundance by mass immediately following
    big bang nucleosynthesis.

  • vice.stable_isotopes : dataframe
    Mapping from elements to their non-radioactive isotopes.

  • Nonzero post-main-sequence lifetimes.

    • vice.cumulative_return_fraction
    • vice.single_stellar_population
    • vice.singlezone.postMS
  • vice.dataframe.remove : function
    Remove a variable from a dataframe.

  • vice.dataframe.filter : function
    Remove variables from a dataframe based on some criteria.

  • vice.yields.presets : module
    Saved presets for nucleosynthetic yield settings.

    • User-constructed presets
    • vice.yields.presets.JW20: built-in preset for Johnson & Weinberg
      (2020) adopted nucleosynthetic yields.
  • vice.elements : module
    A means of accessing yields and other data on an element-by-element basis.

  • vice.imf : module
    Functional forms for popular stellar initial mass functions.

  • vice.singlezone.verbose : property
    Singlezone object can be set to print the simulation time as it runs.

  • vice.singlezone.from_output : function
    Obtain a singlezone object with the same parameters as the one which
    produced some output. Replaces vice.mirror (now deprecated).

  • vice.output.zip and vice.output.unzip : function
    Zip and unzip VICE simulation output directories.

  • vice.VisibleRuntimeWarning : Warning
    A RuntimeWarning which - contrary to the built-in version - is visible
    by default.

  • vice.VisibleDeprecationWarning : Warning
    A DeprecationWarning which - contrary to the built-in version - is
    visible by default.

Patches

  • Fixed a bug that didn't allow metal enhanced outflows in the singlezone
    object.

Initial Release

04 Dec 17:14
Compare
Choose a tag to compare

Initial Release

Robust one-zone model simulation features
Simulations of enrichment from simple stellar populations
Custom nucleosynthetic yield capabilities for supernovae
Yield calculations from results of supernova nucleosynthesis studies
Convenient automatic handling of simulation outputs
A command-line entry for running simple one-zone model simulations