Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cmhamel authored Dec 5, 2024
1 parent 8741ba3 commit bffef0a
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand Down

0 comments on commit bffef0a

Please sign in to comment.