updated README.md and tests expected results

README.md

@@ -9,35 +9,58 @@ MusicBox: A MUSICA model for boxes and columns.
 
 Copyright (C) 2020 National Center for Atmospheric Research
 
-# CMake build
+# Installation
 
-The cmake creates an executable called `music_box`, as well as a set of tests.
+The project is configured to be installed using `pip` by the `pyproject.toml` file. 
 
-## Windows
+This package requires [`musica`](https://pypi.org/project/musica/) to be installed in order to run. `musica` can be installed by running:
 
 ```
-mkdir build
-cd build
-cmake ..
-cmake --build . --config Release
-ctest -C Release --output-on-failure
+pip install musica==0.6.1.dev0
 ```
 
-## Linux, Mac
+To install the `music-box` package into a Python environment, run the following command from the root directory:
 
 ```
-mkdir build
-cd build
-cmake ..
-make
-make test
+pip install .
 ```
 
-# Docker
+The package is also available on PyPi and can be installed in any Python environment through:
 
-To build the docker image
+```
+pip install acom_music_box
+```
+
+# Tests
+
+The tests directory contains 4 different tests that can be ran with [PyTest](https://docs.pytest.org/en/8.2.x/). PyTest can be installed by running:
+
+```
+pip install pytest
+```
+
+After PyTest is intalled, the tests can be ran through the following commands from the root directory:
 
 ```
-docker build -t music_box .
-docker run --rm -it music_box
+cd tests
+pytest
 ```
+
+# Documentation
+
+MusicBox documentation can be built using [Sphinx](https://www.sphinx-doc.org/en/master/). Sphinx can be installed by running:
+
+```
+pip install sphinx
+```
+
+After installing Sphinx, the documentation can be generated by running the following commands in the root directory:
+
+```
+cd doc/sphinx_files
+make html
+```
+
+Then, open `music-box/doc/sphinx_files/build/html/index.html` in a browser.
+
+The documentation includes more detailed instructions for configuring the model, along with developer resources.