Skip to content

Goobley/CommonRTAtomicFormat

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Common Radiative Transfer Atomic Format

Maintainer Chris Osborne Institution University of Glasgow
License License: Apache 2.0

Description

This repository contains the specification for the Common Radiaitive Transfer Atomic Format (CRTAF). CRTAF is intended as both a human readable and data interchange format for atomic data used in non-LTE radiative transfer codes. This is achieved through the use of a clearly specified YAML document. It defines both a high-level (intended for human interaction), and simplified formats (for simple integration into other codes with just a YAML parser).

CRTAF is units aware and supports a common set of functionality present in non-LTE radiative transfer codes such as Lightweaver, RH, SNAPI. The reference python package for interacting with CRTAF models is crtaf.

This package is primarily of use to those working with atomic data to feed into radiative transfer models.

📖 Specification

The current specification is available here. This is a living document, but will be versioned via git tags, and archived via Zenodo.

Current extensions to the specification are available here.

🤝 Contributing

We would love for you to get involved. Please report any typos/bugs encountered on the GitHub issue tracker.

To request the addition of an extension/update the specification, please submit a pull request, or discuss in issues. It is expected that specification changes will also be accompanied by a tested set of changes/extension to the reference implementation crtaf, but please discuss if you are not sure how to go about the desired changes.

We require all contributors to abide by the code of conduct.

Acknowledgments

This format is based on the work of Tiago Pereira for Muspel.jl, along with the atoms as code approach of Lightweaver

About

Common Radiative Transfer Atomic Format Specification

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published