Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
roussel-ryan authored Aug 21, 2024
1 parent ec1871c commit d97c0b7
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
# gpsr_6d_paper
Data and code files related to "Efficient 6-dimensional phase space reconstruction using generative machine learning" paper in PRAB

## Installation

```bash
git clone https://github.com/roussel-ryan/gpsr_6d_paper.git
conda env create -f environment.yml
conda activate ps-reconstruction
```

For a development installation of phase_space_reconstruction package, run the following after creating the environment:

```bash
python -m pip install -e .
```

## Cite
TBD

0 comments on commit d97c0b7

Please sign in to comment.