Merge pull request #21 from ewanwm/feature_wishlist

Add (non-exhaustive) feature wishlist to the readme

README.md

@@ -8,3 +8,24 @@ A lightweight library for calculating neutrino oscillation probabilities using t
 
 [![CI badge](https://github.com/ewanwm/nuTens/actions/workflows/CI-build-and-test.yml/badge.svg)](https://github.com/ewanwm/nuTens/actions/workflows/CI-build-and-test.yml)
 [![Code - Doxygen](https://img.shields.io/badge/Code-Doxygen-2ea44f)](https://ewanwm.github.io/nuTens/index.html)
+
+
+### Feature Wishlist
+- [x] Support PyTorch in tensor library
+- [x] Vacuum oscillation calculations
+- [x] Constant matter density propagation
+- [x] Basic test suite
+- [x] Basic CI
+- [x] Doxygen documentation with automatic deployment
+- [ ] Add test coverage checks into CI
+- [ ] Integrate linting ( [cpp-linter](https://github.com/cpp-linter)? )
+- [ ] Add instrumentation library for benchmarking and profiling
+- [ ] Add suite of benchmarking tests
+- [ ] Integrate benchmarks into CI ( maybe use [hyperfine](https://github.com/sharkdp/hyperfine) and [bencher](https://bencher.dev/) for this? )
+- [ ] Add proper unit tests
+- [ ] Expand CI to include more platforms
+- [ ] Add support for modules (see [PyTorch doc](https://pytorch.org/cppdocs/api/classtorch_1_1nn_1_1_module.html))
+- [ ] Propagation in variable matter density
+- [ ] Add support for Tensorflow backend
+- [ ] Add python interface 
+