Jekyll-based website for the MESA stellar evolution code
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_includes Add missing file Dec 1, 2017
_layouts Update pages that display defaults files Jul 14, 2014
_plugins Allow ToC to not be at the top Jul 16, 2014
_posts New SDK release Jan 28, 2018
assets Update maps Jan 1, 2018
css Switch to black background Sep 6, 2016
docs Add standalone docs files for r10108 Dec 8, 2017
.gitignore Ignore autosave and backup files Jun 19, 2014
00-index.markdown Merge branch 'maint' Feb 27, 2018
01-capabilities.markdown Instrument paper 4 published Feb 13, 2018
02-prereqs.markdown Instrument paper 4 published Feb 13, 2018
03-starting.markdown Make implicit newlines explicit Jan 16, 2018
04-pgstar.markdown fixed command that generated a fortran stop Jun 24, 2014
05-output.markdown Replace existing mentions of mesastar.org Apr 4, 2017
06-howto.markdown Add note about user-submitted run_star_extras Apr 4, 2017
07-troubleshooting.markdown Fix typo Sep 28, 2017
08-faq.markdown Update FAQ about compiling older versions Feb 13, 2018
10-format.markdown Hide format page from sidebar Jul 21, 2014
11-star_job.markdown Add multiple docs versions Aug 10, 2016
12-controls.markdown Add multiple docs versions Aug 10, 2016
13-pgstar.markdown Add multiple docs versions Aug 10, 2016
14-binary.markdown Add multiple docs versions Aug 10, 2016
94-mesa4.markdown Update MESA IV figure numbers Jan 4, 2018
99-allnews.markdown Add page to show old news items Jul 3, 2014
README.org Keep tweaking Dec 1, 2017
_config.yml Stop using redcarpet Oct 30, 2017
defaultsParser.rb Allow empty comments that have a space Oct 17, 2014
make_docs.rb Add r10108 docs Oct 23, 2017
markdownTransformer.rb Don't escape underscores and asterisks Jul 19, 2014

README.org

MESA Website

This is the source code of the website for the MESA stellar evolution code.

You can view the site here.

Contributing

Did you find an error? Do you see something that can be improved? Do you have other materials you’ve written yourself that you think could be incorporated? If so please either:

Email Me

If you subscribe to the mesa-users mailing list, you should have no trouble finding my email address.

Contribute via GitHub

Clone this repo and send me a pull request.

Branching and Merging

There are two branches.

maint

This branch contains the public version of the site. Pull requests which fix problems spotted at mesa.sourceforge.net should be made against this branch. maint is merged into master at least as often as MESA is released.

git checkout master
git merge maint

master

This branch contains changes which should be published in the next MESA release. master is merged into maint at the time of a new MESA release.

git checkout maint
git merge --ff-only master

There has not yet been a need for development on a longer timescale than that, so there is not a separate dev branch.

Repository Layout

This site uses the jekyll static site generator.

??-<name>.markdown

These files are the main pages of the site. They are written in Markdown and then the HTML pages are generated from these files.

assets/

This directory contains images, movies, etc.

_config.yml

This file contains options to control the configuration of jekyll.

css/

This directory contains the CSS files. (They could use a good cleanup from someone who knows modern CSS.)

docs/

This directory contains the MESA defaults files. Each version gets its own sub-directory.

_includes/

This directory contains snippets like the site header (head.html), left side bar (leftside.html) and right news bar (news.html).

_layouts/

This directory has HTML templates that control the overall layout of the site.

_plugins/

This directory contains plug-ins (written in Ruby), which allow one to extend the functionality of jekyll.

_posts/

This directory contains a Markdown file for each of the MESA news posts that appear in the right hand sidebar.

_site/

This directory should not be under version control, but will be created once you run jekyll. It contains the static version of the website, which is what is copied to the sourceforge server.

Generating

If you’re making significant changes to the site, you probably want to see the effects of your changes as you go along. You can generate and view a version of the site on your own machine.

First, install a current version (2.3+) of ruby, using whichever tools are appropriate for your OS (e.g., port, brew, apt-get, pacman, etc.). This will come with rubygems (a ruby package manager).

Next, install the following gems. (Rubygems will take care of installing their dependencies).

gem install jekyll
gem install therubyracer
gem install nokogiri
gem install parslet

Then, clone this git repository.

git clone https://github.com/MESAHub/mesa-website

Now, change to the mesa-website directory and tell jekyll to serve a local copy of the site for you.

jekyll serve --watch

Visit 0.0.0.0:4000 in your web browser to see the site. As you edit the files, the site will be regenerated to reflect the changes you’ve made. Read the jekyll documentation to learn more.

Once you’ve finished making your changes, commit them and then send me a pull request or email me a patch.

Publishing

The site is auto-deployed to sourceforge after pushes to the maint branch.

Doing a MESA release

The following things need to be done when a new MESA release occurs.

Edit _config.yml

Update the version number to the current release.

Check the tutorial

Make a copy of the star/work directory and run the default inlists with the new MESA version. Check to make sure that the output roughly agrees with what is written in 03-staring.markdown. If not, update the tutorial to reduce possible confusion for new users.

Add a news post

Copy an existing release newspost (e.g., _posts/2014-06-08-r6596.markdown) and update the date and release number. Briefly summarize the release notes, mentioning any major changes or issues that require user intervention. Link to the mailing list post announcing the new release.

Update the defaults files

Copy the defaults files for the latest release.

mkdir docs/r?????
cp $MESA_DIR/star/defaults/*.defaults docs/r?????/

Now add the new version in to the DEFAULTS_VERSION variable the provided parser/converter (make_docs.rb). Then run it

ruby make_docs.rb

and check that it is successful.

Edit the docs index docs/index.markdown and add the new version to the listing. (This could probably be automated, though the defaults files haven’t been constant in name or number over the life of MESA.)

Commit the *.defaults files and the *.markdown files that were generated by the make_docs.rb script. The reason for re-generating everything is that it lets us take advantage of improvements made to the Markdown output. If not backwards-compatible changes are made, older versions can be removed from the version list and thus new *.markdown files will no longer be generated.

Upload a new zip file to sourceforge

Make a zip file of the latest release. Here’s an example script to do that.

do_one() {

    MESA_SVN=/home/jschwab/Software/mesa-svn
    MESA_FILENAME=mesa-r$1

    svn export -r $1 ${MESA_SVN} ${MESA_FILENAME}

    zip -r ${MESA_FILENAME}.zip ${MESA_FILENAME}
    rsync -e ssh ${MESA_FILENAME}.zip frs.sourceforge.net:/home/frs/project/mesa/releases

    rm ${MESA_FILENAME}.zip
    rm -rf ${MESA_FILENAME}

}

do_one 6596

If you need to adjust the modification date of the zipfile, here’s a sketch how to do so.

Get the modification date from the svn logs:

svn log -r 6596 ${MESA_SVN} | grep -oE "[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} -[0-9]{4}"

Get a shell on sourceforge:

ssh -t jschwab,mesa@shell.sourceforge.net create

In the shell, touch the file with the date:

touch --date="2014-06-06 19:30:30 -0700" mesa-r6596.zip