You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+12-21
Original file line number
Diff line number
Diff line change
@@ -5,30 +5,14 @@
5
5
6
6
## Introduction
7
7
8
-
The nuclear mass tables produced by [NUBASE](http://amdc.in2p3.fr/web/nubase_en.html) and [AME](https://www-nds.iaea.org/amdc/)are parsed into pandas dataframes.
9
-
These dataframes are then read with the [dash](https://plotly.com/dash/) module to create an interactive webpage to allow the user to interogate the data they are interested in.
8
+
The nuclear mass tables produced by [NUBASE](http://amdc.in2p3.fr/web/nubase_en.html) and [AME](https://www-nds.iaea.org/amdc/)have unique formats.
9
+
This package does the hard work for you and parses the files into a single pandas dataframe for simpler access.
10
10
11
11
No guarantee is supplied with regards to the accuracy of the data presented.
12
12
Estimated values are included, please always refer to the original sources.
13
13
All data should, however, be accurate.
14
14
15
-
Additional functionality and polish will be added as I learn more about [dash](https://plotly.com/dash/).
16
-
In the meantime, suggestions are welcome via [issues](https://github.com/php1ic/pynch/issues) or a pull request.
17
-
18
-
## Setup
19
-
20
-
As is the standard, you can confirm you have the necessary modules using the [requirements.txt](./requirements.txt) file
21
-
```bash
22
-
pip install --user -r requirements.txt
23
-
```
24
-
25
-
## Running
26
-
27
-
With all of the necessary requirements installed, the below will start the app
28
-
```bash
29
-
python3 app.py
30
-
```
31
-
The console will tell you where to point your browser - likely http://127.0.0.1:8050/.
15
+
Suggestions are welcome via [issues](https://github.com/php1ic/pynch/issues) or a pull request.
32
16
33
17
## Mass tables
34
18
@@ -41,9 +25,16 @@ The data files released by the papers linked below are used to create the mass t
41
25
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.
42
26
No comparison or validation is done on common values.
43
27
44
-
## Additional uses
28
+
## Setup
29
+
30
+
Until the package is added to Python Package Index, the local clone of the repo must be installed from within the top level directory.
31
+
```bash
32
+
pip install -e .
33
+
```
34
+
35
+
## Usage
45
36
46
-
If you want to do your own thing with the data, you could import this module, access `MassTable().full_data`, then sort, slice and filter the resultant dataframe to your heart's content.
37
+
Import the module to access `MassTable().full_data`, then sort, slice and filter the resultant dataframe to your heart's content.
47
38
48
39
For example, track how the accuracy of the mass excess of 18B changes once it is experimentally measured
0 commit comments