Skip to content

Commit 8681a30

Browse files
committed
Update the README file
1 parent 0b6be78 commit 8681a30

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
# Nuclear Masses
22

3-
Python package to parse the various files published by the AME and NUBASE.
3+
## Introduction
4+
5+
Python package to parse the various files published by the [AME](https://www-nds.iaea.org/amdc/) and [NUBASE](http://amdc.in2p3.fr/web/nubase_en.html).
6+
The files produced by the AME and NUBASE have unique formats so this package does the hard work for you and parses the data into a [pandas dataframe](https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.html) for simple access.
7+
8+
No guarantee is supplied with regards to the accuracy of the data presented.
9+
Estimated values are included, please always refer to the original sources.
10+
All data should, however, be accurate.
11+
12+
## Mass tables
13+
14+
The data files released by the papers linked below are used to create the mass tables read by this code
15+
- [AME2003](https://doi.org/10.1016/j.nuclphysa.2003.11.002) + [NUBASE2003](https://doi.org/10.1016/j.nuclphysa.2003.11.001)
16+
- [AME2012](https://doi.org/10.1088/1674-1137/36/12/002) + [NUBASE2012](https://doi.org/10.1088/1674-1137/36/12/001)
17+
- [AME2016](https://doi.org/10.1088/1674-1137/41/3/030002) + [NUBASE2016](https://doi.org/10.1088/1674-1137/41/3/030001)
18+
- [AME2020](https://doi.org/10.1088/1674-1137/abddaf) + [NUBASE2020](https://doi.org/10.1088/1674-1137/abddae)
19+
20+
The NUBASE files are read for all of the data values, with the AME files being used to populate an additional mass excess data field.
21+
No comparison or validation is done on common values.
22+
23+
## Setup
24+
25+
The package is available on the Python Package Index so can be installed via pip
26+
```bash
27+
pip install nuclearmasses
28+
```
429

0 commit comments

Comments
 (0)