Skip to content

Commit e2819ff

Browse files
committed
Update README after changes to project a package
1 parent 1b9926e commit e2819ff

File tree

1 file changed

+12
-21
lines changed

1 file changed

+12
-21
lines changed

README.md

+12-21
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,14 @@
55

66
## Introduction
77

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.
1010

1111
No guarantee is supplied with regards to the accuracy of the data presented.
1212
Estimated values are included, please always refer to the original sources.
1313
All data should, however, be accurate.
1414

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.
3216

3317
## Mass tables
3418

@@ -41,9 +25,16 @@ The data files released by the papers linked below are used to create the mass t
4125
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.
4226
No comparison or validation is done on common values.
4327

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
4536

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.
4738

4839
For example, track how the accuracy of the mass excess of 18B changes once it is experimentally measured
4940
```python

0 commit comments

Comments
 (0)