-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #150 from lephare-photoz/raphaelshirley-patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
26 additions
and
49 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,44 @@ | ||
| # lephare | ||
| | <img src="https://avatars.githubusercontent.com/u/165841626?s=400&u=ff86bd4c19a9d36958cf1b47d84849dbe25c274a&v=4" width="140"/> | LePHARE <br> PHotometric Analysis for Redshift Estimation <br> <br> [](https://pypi.org/project/lephare/) [](https://github.com/lephare-photoz/lephare/actions/workflows/smoke-test.yml) [](https://codecov.io/gh/lephare-photoz/lephare) [](https://lephare.readthedocs.io/) | | ||
| |---|---| | ||
|
|
||
| [](https://lincc-ppt.readthedocs.io/en/latest/) | ||
| LePHARE is a code for estimating galaxy redshifts and physical parameters using template fitting. It is a complete rewrite in C++ of the [Fortran code](https://www.cfht.hawaii.edu/~arnouts/LEPHARE), with python binding and extension using [pybind11](https://github.com/pybind/pybind11). | ||
|
|
||
| The code documentation, including how to install it and to get started, can be found [here](https://lephare.readthedocs.io/). | ||
|
|
||
| [](https://pypi.org/project/lephare/) | ||
| [](https://github.com/lephare-photoz/lephare/actions/workflows/smoke-test.yml) | ||
| [](https://codecov.io/gh/lephare-photoz/lephare) | ||
| [](https://lephare.readthedocs.io/) | ||
| **IMPORTANT!** The current repository is under development. If you wish to use LePHARE for science work, please download it from the [currently stable repository](https://gitlab.lam.fr/Galaxies/LEPHARE/). | ||
|
|
||
| IMPORTANT! This project is in an early development stage. If you wish to use and run LePHARE please download it from the [official repository](https://gitlab.lam.fr/Galaxies/LEPHARE/). | ||
| # Requests and help | ||
|
|
||
| LePHARE (PHotometric Analysis for Redshift Estimation) is a Python package built on a complete rewrite in C++ of the [Fortran code](https://www.cfht.hawaii.edu/~arnouts/LEPHARE/acknowledgement.html) LePhare. | ||
| LePHARE computes photometric redshifts and physical parameters by fitting spectral energy distributions (SED) to a dataset of photometric fluxes or apparent magnitudes. | ||
| If you need help with the code, or if you have feature requests, please use the github issue system to let us know. | ||
|
|
||
| ## Installation | ||
| # Citing LePHARE | ||
|
|
||
| The simplest way to install lephare is using pip: | ||
| If you use LePHARE, please acknowledge it with the following references: | ||
|
|
||
| ``` | ||
| pip install lephare | ||
| ``` | ||
| - Arnouts, S.; Cristiani, S.; Moscardini, L., Matarrese, S., Lucchin, F. et al., 1999, MNRAS, 310, 540 | ||
|
|
||
| If you have any problems using pip install please consider creating an issue and informing us what system you are using in order to help us improve robustness. | ||
| - Ilbert, O.; Arnouts, S.; McCracken, H. J.; Bolzonella, M.; Bertin, E et al., 2006, A&A, 457, 841 | ||
|
|
||
| ## Example usage | ||
| # Contributors | ||
|
|
||
| We provide a number of [Jupyter notebooks](docs/notebooks/) demonstrating various aspects of the Python code. | ||
| LePHARE was originally developped in Fortran by [Stéphane Arnouts](https://people.lam.fr/arnouts.stephane/) and [Olivier Ilbert](https://people.lam.fr/ilbert.olivier/). | ||
|
|
||
| ## Dev Guide - Getting Started | ||
| The C++ and python rewriting of the code is the work of Olivier Ilbert, [Johann Cohen-Tanugi](https://github.com/johannct), and [Raphael Shirley](http://raphaelshirley.co.uk/). | ||
|
|
||
| Before installing any dependencies or writing code, it's a great idea to create a | ||
| virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual | ||
| environments. If you have conda installed locally, you can run the following to | ||
| create and activate a new environment. | ||
| Other contributors include: | ||
| Iary Davidzon, Mara Salvato (MPE), Cédric Dubois (LAM), and Maria Petkova. | ||
|
|
||
| ``` | ||
| >> conda create -n <env_name> python=3.10 | ||
| >> conda activate <env_name> | ||
| ``` | ||
| We acknowledge fruitful discussions with | ||
| Emeric Le Floc'h (CEA), Léo Michel-Dansac (LAM), Jean-Charles Lambert (LAM). | ||
|
|
||
| Once you have created a new environment, you can install this project for local | ||
| development using the following commands: | ||
|
|
||
| ``` | ||
| >> git submodule update --init --recursive | ||
| >> conda install -c conda-forge cxx-compiler | ||
| >> pip install -e .'[dev]' | ||
| >> pre-commit install | ||
| >> conda install pandoc | ||
| ``` | ||
| # Acknowledgements | ||
| [](https://lincc-ppt.readthedocs.io/en/latest/) | ||
|
|
||
| Notes: | ||
| 1. The single quotes around `'[dev]'` may not be required for your operating system. | ||
| 2. `pre-commit install` will initialize pre-commit for this local repository, so | ||
| that a set of tests will be run prior to completing a local commit. For more | ||
| information, see the Python Project Template documentation on | ||
| [pre-commit](https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html) | ||
| 3. Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks | ||
| into documentation for ReadTheDocs works as expected. For more information, see | ||
| the Python Project Template documentation on | ||
| [Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks) | ||
| This project was automatically generated using the LINCC-Frameworks [python-project-template](https://github.com/lincc-frameworks/python-project-template). | ||
| For more information about the project template see the [documentation](https://lincc-ppt.readthedocs.io/en/latest/). | ||
|
|
||
| The authors gratefully acknowledge the important contribution of LINCC Framework members (notably [Olivia Lynn](https://github.com/OliviaLynn) and [Drew Oldag](https://github.com/drewoldag)) to the | ||
| construction of the LePHARE github infratructure. | ||
|
|
||
| This project was automatically generated using the LINCC-Frameworks | ||
| [python-project-template](https://github.com/lincc-frameworks/python-project-template). | ||
| For more information about the project template see the | ||
| [documentation](https://lincc-ppt.readthedocs.io/en/latest/). | ||
| The LePHARE logo is the work of [Eve Barlier](https://www.instagram.com/eve.barlier/). Thank you! |