Skip to content

Update README.md #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ajeldorado merged 1 commit into from
Nov 10, 2025
Merged

Update README.md #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down