From 6a30a8371ed54a5050f48cdbc9dc9fd62d9bcbcf Mon Sep 17 00:00:00 2001 From: Susan Redmond <43475978+sfr348@users.noreply.github.com> Date: Thu, 30 Oct 2025 12:08:14 -0700 Subject: [PATCH] Update README.md added instruction to run install command --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b2fcd39..475fafc 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,12 @@ Major contributions and testing were provided by Garreth Ruane, Luis Marchen, Sa ### DOCUMENTATION * The only non-standard library you need is PROPER, available only via download here: https://sourceforge.net/projects/proper-library/ -* To get started, add PROPER and falco-python to your PYTHONPATH. Then try running some scripts in the falco-python/examples/ folder starting with EXAMPLE_main* or demo_*. +* To get started, add PROPER and falco-python to your PYTHONPATH. +* cd into falco-python home directory and run: +``` +python -m pip install . +``` +* Then try running some scripts in the falco-python/examples/ folder starting with EXAMPLE_main* or demo_*. * Documentation on specific usage cases is available at the Matlab version's Github Wiki at https://github.com/ajeldorado/falco-matlab/wiki. * For an overview of FALCO and its uses, refer to the SPIE conference paper "Fast Linearized Coronagraph Optimizer (FALCO) I: A software toolbox for rapid coronagraphic design and wavefront correction". DOI: 10.1117/12.2313812