Metadata-Version: 2.4
Name: yrec
Version: 2026.2.dev0
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: dulwich

# YREC

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17981745.svg)](https://doi.org/10.5281/zenodo.17981745)

## What the YREC package does

This provides a wrapper around the Yale Rotating Evolution Code (YREC)
application to allow it to be used conveniently from within the Python
programming langauge.

## How to install YREC

To install this package run:

`python -m pip install yrec`

## Get started using YREC

A quick example showing how to create and run a model:

```python
>>> import yrec
>>> mymodel = yrec.model('control.nml1' 'physics.nml2')
>>> mymodel.run()
True
```

A return value of `True` indicates that the model ran without error. `False`
indicates there was a problem.  The terminal output from the run is captured in
a file named after the namelist files read to create the model.

## Documentation

Additional documentation for this package and for the core YREC code that this package wraps
here: [[https://yrec.readthedocs.io/en/latest/](https://yrec.readthedocs.io/en/latest/)]

## Community

YREC development, news, and discussion may be found here:
[[https://github.com/yreclab/yrec](https://github.com/yreclab/yrec)]

## Citation
Pinsonneault, M. (2025). The YREC Stellar Evolution Code: Public Data Release. https://doi.org/10.5281/zenodo.17981745
