Merge branch 'sce_branch' of https://github.com/yiqunyu/RAM-SCB into …

…sce_branch

CITATION.cff

@@ -0,0 +1,46 @@
+cff-version: 1.2.0
+title: RAM-SCB
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file. Please also cite the paper
+  by Engel et al. (2019; doi:10.1029/2018JA026260) and
+  other relevant papers describing the model featues
+  used.
+type: software
+authors:
+  - given-names: Vania K.
+    family-names: Jordanova
+    email: [email protected]
+    affiliation: Los Alamos National Laboratory
+    orcid: 'https://orcid.org/0000-0003-0475-8743'
+  - given-names: Miles A.
+    family-names: Engel
+    affiliation: Los Alamos National Laboratory
+    orcid: 'https://orcid.org/0000-0003-4248-9636'
+  - given-names: Steven K.
+    family-names: Morley
+    affiliation: Los Alamos National Laboratory
+    orcid: 'https://orcid.org/0000-0001-8520-0199'
+  - given-names: Daniel T.
+    family-names: Welling
+    affiliation: University of Michigan
+    orcid: 'https://orcid.org/0000-0002-0590-1022'
+  - given-names: Yiqun
+    family-names: Yu
+    affiliation: Beihang University
+    orcid: 'https://orcid.org/0000-0002-1013-6505'
+  - given-names: Kateryna
+    family-names: Yakymenko
+    affiliation: Los Alamos National Laboratory
+    orcid: 'https://orcid.org/0000-0002-7663-8006'
+  - given-names: Rehana
+    family-names: Mahfuz
+    orcid: 'https://orcid.org/0000-0002-9974-1137'
+  - given-names: Humberto C.
+    family-names: Godinez
+    affiliation: Los Alamos National Laboratory
+    orcid: 'https://orcid.org/0000-0001-7138-3481'
+  - given-names: Louis
+    family-names: Vernon
+  - given-names: Cristoph
+    family-names: Junghans

README.md

@@ -1,5 +1,5 @@
 # RAM-SCB
-
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.6977287.svg)](https://doi.org/10.5281/zenodo.6977287)
 [![ramscb-ci](https://github.com/lanl/RAM-SCB/actions/workflows/ramscb-ci.yml/badge.svg)](https://github.com/lanl/RAM-SCB/actions/workflows/ramscb-ci.yml)
 
 The **R**ing current **A**tmosphere interactions **M**odel with **S**elf **C**onsistent magnetic field (**B**) is a unique code that combines a kinetic model of ring current plasma with a three dimensional force-balanced model of the terrestrial magnetic field. The kinetic portion, RAM, solves the kinetic equation to yield the bounce-averaged distribution function as a function of azimuth, radial distance, energy and pitch angle for three ion species (H+, He+, and O+) and, optionally, electrons. The 3-D force balanced magnetic field model, SCB, balances the **J** × **B** force with the divergence of the general pressure tensor to calculate the magnetic field configuration within its domain. The two codes work in tandem, with RAM providing anisotropic pressure to SCB and SCB returning the self-consistent magnetic field through which RAM plasma is advected. RAM-SCB has grown from a research-grade code with limited options and static magnetic field (RAM) to a rich, highly configurable research and operations tool with a multitude of new physics and output products. The RAM-SCB manual provides a guide to users who want to learn how to install, configure, and execute RAM-SCB simulations. While the code is designed to make these steps as straight-forward as possible, it is strongly recommended that users review the publications listed in the Bibliography to ensure a thorough understanding of the physics included in the model.