mathren / CE_accretors

Study the impact of previous RLOF mass transfer on the binding energy of the accretor and implications for the common envelope in the evolution of isolated GW progenitors
MIT License
0 stars 0 forks source link

+BEGIN_html

showyourwork

Article status Article tarball Read the article DOI

+END_html

** How to build the article locally

(See also the [[https://show-your.work/en/latest/][showyourwork documentation]])

Assuming you have a working installation of conda, you can [[https://show-your.work/en/latest/install/][install showyourwork]], clone this repository, and just run =showyourwork= and it should work:

+BEGIN_SRC bash

pip install -U showyourwork git clone git@github.com:mathren/CE_accretors.git cd CE_accretors showyourwork

+END_SRC

The first time this will download the data (1.7 Gb) and process them -- unpacking up to 8.3 Gb of MESA output. Downloading, unpacking the data, and pre-processing them may take long (~30min on my workstation including the time to download the data):

+BEGIN_SRC bash

time showyourwork [...] showyourwork 1081s user 27m9.104s sys 0m59.076s

+END_SRC

After the data exist cached on your machine, this will be much faster (how much depends on what has changed in the repo that needs to be redone).

You can also edit and should be able to compile locally the =tex= file (see below). If you have never ran =showyourwork= locally, then the figures will be missing on your machine (but you can still compile using the =draft= option). If you have ever ran =showyourwork= you will have a (possibly outdated) version of the figures locally, and you can compile the =tex= as you would usually.

*** Structure of the repository

This follows the structure prescribed by [[https://github.com/showyourwork/showyourwork][showyourwork]].

**** =src/tex= LaTeX files for the paper

 The figures =pdf= are not saved in the git repo, instead they are
 generated by =showyourwork=.

**** =src/scripts= python scripts for the paper

 Contains the scripts and libraries used for the analysis and to
 make the figures in the paper

**** =src/data/=

 When running =showyourwork= locally, the data will be downloaded
 from zenodo and saved in a subfolder =MESA_output=, which the
 python scripts expect to exist before they can run.

***** =src/data/MESA_input=

  The subfolders here contain template MESA work directory used to
  run our models. Tarball containing the exact template used for
  the models in the paper are also uploaded on [[https://zenodo.org/record/6600641][zenodo]] -- the
  template here may evolve in the future.

  This project uses =MESA version 15140=, =MESA SDK
  x86_64-linux-20.12.1= (also logged in the =*.data= files), which
  includes the compiler:

  #+BEGIN_SRC bash
  gfortran --version
  GNU Fortran (GCC) 10.2.0
  #+END_SRC

  Please refer to the [[https://docs.mesastar.org/en/r15140/][MESA documentation]] and [[https://lists.mesastar.org/mailman/listinfo][mailing list]] for
  support.