From bffef0ad4f089035241aa7c8cf45f9e66b960d00 Mon Sep 17 00:00:00 2001
From: cmhamel <31457225+cmhamel@users.noreply.github.com>
Date: Thu, 5 Dec 2024 15:04:21 -0500
Subject: [PATCH] Update README.md

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index a4882d7..c6e1af5 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,8 @@ Physics augmented neural computations in jax
 
 ## Table of Contents
 1. [Installation](#installation)
-2. [Citation](#citation)
+2. [Usage](#usage)
+3. [Citation](#citation)
 
 ## Installation
 ### CPU installation instructions
@@ -34,6 +35,18 @@ folder, run the following command
 
 If you leverage these tools for your own research, please cite the following article
 
+## Usage
+Currently the main entry point to pancax is through a python script (although a yaml input file is also in the works).
+To run a script you can run the following command
+
+``python -m pancax -i my_script.py``
+
+where ``my_script.py`` is the name of the scipt you've written. This will run the python script while also 
+respecting several environment variables which can be supplied after the ``pancax`` keyword above. A list of
+these can be displayed with the help message
+
+``python -m pancax -h``
+
 ## Citation
 ```bibtex
 @article{hamel2023calibrating,