Merge pull request #7 from openmc-data-storage/improved_readme

improved readme

Author: shimwell

.github/workflows/test_package.yml

@@ -4,10 +4,16 @@ on:
   workflow_dispatch:
   pull_request:    
     branches:
-    - main  
+      - main
+    paths-ignore:
+      - "**.md"
+      - "**.txt"
+      - "**.cff"
+      - 'docs/**'
+      - '.gitignore'
   push:
     branches:
-    - main
+      - main
 
 
 jobs:

.github/workflows/test_processing.yml

@@ -4,10 +4,16 @@ on:
   workflow_dispatch:
   pull_request:    
     branches:
-    - main  
+      - main
+    paths-ignore:
+      - "**.md"
+      - "**.txt"
+      - "**.cff"
+      - 'docs/**'
+      - '.gitignore'
   push:
     branches:
-    - main
+      - main
 
 
 jobs:

.github/workflows/test_urls.yml

@@ -4,7 +4,13 @@ on:
   workflow_dispatch:
   pull_request:    
     branches:
-    - main  
+      - main
+    paths-ignore:
+      - "**.md"
+      - "**.txt"
+      - "**.cff"
+      - 'docs/**'
+      - '.gitignore'  
   push:
     branches:
     - main

README.md

@@ -1,26 +1,20 @@
 [![test_urls](https://github.com/shimwell/data/actions/workflows/test_urls.yml/badge.svg)](https://github.com/shimwell/data/actions/workflows/test_urls.yml)
-
 [![test_package](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_package.yml/badge.svg)](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_package.yml)
-
 [![test_convert_scripts](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_processing.yml/badge.svg)](https://github.com/openmc-data-storage/openmc_data/actions/workflows/test_processing.yml)
 
 
-# OpenMC Data Scripts
-
-This repository contains a collection of scripts for generating HDF5 data
-libraries and xml chain files that can be used with OpenMC. Some of these
-scripts convert existing ACE libraries (such as those produced by LANL) whereas
-generate scripts use NJOY to process ENDF files directly.
+# OpenMC Data
 
-Another source of data libraries for OpenMC is the [Windowed Multipole Library](https://github.com/mit-crpg/WMP_Library) repository which enables on-the-fly Doppler broadening to an arbitrary temperature.
+Aims to facilitate the use of different nuclear data libraries with OpenMC by
+providing command line tools that process and download nuclear data automatically.
 
 # Prerequisites
 
 You should have already installed OpenMC, see the [docs](https://docs.openmc.org/en/stable/quickinstall.html) for installation instructions.
 
 # Installation
 
-Currently the package can be installed from this temporary repository.
+The package is distributed on [PYPI](https://pypi.org/project/openmc-data/) and can be installed with pip.
 
 ```bash
 pip install openmc_data
@@ -37,7 +31,7 @@ For example:
 
 ```convert_endf --help```
 
-Some scripts (mainly the generate scripts) require NJOY to be installed and
+Some scripts (mainly the generate scripts) require [NJOY](https://github.com/njoy/NJOY2016) to be installed and
 added to your path.
 
 A few categories of scripts are available: