Skip to content

Commit

Permalink
[skip travis] doc: minor updates to migration/, examples/ README files
Browse files Browse the repository at this point in the history
  • Loading branch information
giganano committed Mar 17, 2021
1 parent 406ba51 commit c15253b
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 10 deletions.
46 changes: 36 additions & 10 deletions examples/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
VICE Example Code
+++++++++++++++++

First time users of VICE should first go through the `quick start tutorial`__
First time users of VICE should first go through the `tutorial`__
to familiarize themselves with how to use VICE's basic features.

__ tutorial_
Expand All @@ -11,37 +11,63 @@ __ tutorial_
Here we also provide example scripts to help users further familiarize
themselves with VICE.

1. `A Simple Example`__: Run a simple onezone model and plot the results
1. `A Simple Example`__: Run a simple one-zone model and plot the results
2. **yields.py**: Modify nucleosynthetic yield settings
3. **yield_import.py**: Import nucleosynthetic yield settings from another file
4. **generate_functions.py**: Generate functions for use in simulations

__ example_

Journal Related Examples
========================
Included in VICE's source tree is code which runs the simulations and produces
the figures in `Johnson & Weinberg (2020)`__ and Johnson et al. (2021).
While not located in this directory, users are welcome to use these scripts as
examples of how to use VICE.

__ jw20_
.. _jw20: https://ui.adsabs.harvard.edu/abs/2020MNRAS.498.1364J/abstract

*Note*: Links to the Johnson et al. (2021) paper will be added here following
its announcement.

Johnson & Weinberg (2020) Starbursts Paper Code
===============================================
-----------------------------------------------

|paper1|

.. |paper1| image:: https://img.shields.io/badge/NASA%20ADS-Johnson%20%26%20Weinberg%20(2020)-red
:target: https://ui.adsabs.harvard.edu/abs/2019arXiv191102598J/abstract
:alt: paper1

Included in VICE's source tree is the `code`__ which runs the simulations and
produces all of the figures in `Johnson & Weinberg (2020)`__. While not
located in this directory, users are welcome to use it as examples of how to
use VICE. This code can also be ran by running ``make starburst`` from VICE's
source directory.
Code for the `Johnson & Weinberg (2020)`__ models is available `here`__, in
VICE's GitHub repository under ``starbursts``.
These models focus on the effects of bursty star formation histories in
one-zone models.

__ starbursts_
__ jw20_
__ starbursts_
.. _starbursts: https://github.com/giganano/VICE/tree/master/starbursts
.. _jw20: https://ui.adsabs.harvard.edu/abs/2019arXiv191102598J/abstract

.. _example:

Johnson et al. (2021) Migration Paper Code
------------------------------------------
Code for the Johnson et al. (2021) models is available `here`__, in VICE's
GitHub repository under ``migration``.
These models focus on the effects of stellar migration on the enrichment
history of the Milky Way.

__ migration_
.. _migration: https://github.com/giganano/VICE/tree/master/migration


A Simple Example: A Simulation of a Galaxy with Known Star Formation History
============================================================================
Below is a simple example of how to run a one-zone model of a galaxy where
VICE is ran in star formation mode (i.e. the user specifies the star
formation history).

.. code:: python
import matplotlib.pyplot as plt
Expand Down
3 changes: 3 additions & 0 deletions migration/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,9 @@ These parameters simply tell the script which figure(s) you'd like produced.
For example, ``python figures.py --fig9`` will produce only Fig. 9 of
Johnson et al. (2021), where as ``python figures.py --fig9 --fig10`` will
produces Figs. 9 and 10.
This script saves figures here under a directory named ``figures``; users
should therefore be careful to run ``mkdir figures`` prior to running
the ``figures.py`` script.

**WARNING**: In order for this script to work properly, the outputs of each of
the Johnson et al. (2021) models need to be at the following locations:
Expand Down
Binary file removed migration/figures/ofe_mdfs.zip
Binary file not shown.

0 comments on commit c15253b

Please sign in to comment.