From d97c0b7a84f1521c7b0addb58061d34796abbb8e Mon Sep 17 00:00:00 2001 From: Ryan Roussel Date: Wed, 21 Aug 2024 12:35:56 +0200 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 091985c..f664680 100644 --- a/README.md +++ b/README.md @@ -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