Marc Pinsonneault logo

Marc Pinsonneault

Archives
March 26, 2026

Orientation to YREC

Hello all. The public release paper for YREC has now been accepted for publication. The YREC code, the associated documentation, the input files needed to run it, the test suite, and various tools associated with YREC can be accessed as follows. The documentation can be found here. The current version of the repository is on github, and the stable version used in the release paper can be found in the release paper branch. There is also a YREC Zenodo community.

To install and run YREC, you have several choices. The classic way of doing so involves cloning the repository to a Linux machine, compiling the fortran code, and then running in that environment. Similar procedures can be used for Mac and Windows systems; in the latter case the cleanest procedure can actually be to install a Linux environment and install YREC there. We recommend starting by running the test suite, and using the cases presented in the repository as a guide in setting up your own work.

However, it is also possible to set up a dedicated codespace in Github (go to the green code button, and select codespaces); this will automatically compile YREC and set up an local environment where you can run it, agnostic to the operating system that you are using. You will need a Github account, which includes limited free cloud computing. Note that you can use codespaces for an extended period of time, and do not need to do so every time you run the code.

Finally, there is also an online version of the code, which runs in a browser.

If you have questions or challenges in installation, please raise them in the github discussion forum for yrec. Please make sure to give key information, including the version of the code that you are using, the namelists, and a brief description of the problem. The short file, generated during code runs, is also helpful, as it contains diagnostic information. If you can’t find an answer to your question there, email me at pinsonneault.1@osu.edu.

In this newsletter we will provide notices of code updates and information about YREC and its usage.

Don't miss what's next. Subscribe to Marc Pinsonneault:
Powered by Buttondown, the easiest way to start and grow your newsletter.