Skip to content

Commit

Permalink
better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-superonion committed Mar 29, 2022
1 parent 136aef7 commit 9980f6b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 16 deletions.
9 changes: 6 additions & 3 deletions README.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,15 @@
id="fpfs-fourier-power-function-shaplets-a-fast-accurate-shear-estimator">#
<code>FPFS</code>: Fourier Power Function Shaplets (A fast, accurate
shear estimator)</h2>
<h2 id="installation">## Installation</h2>
<h2 id="installation">Installation</h2>
<p>For stable version:</p>
<pre class="shell"><code>pip install FPFS</code></pre>
<p>Or clone the repository:</p>
<pre class="shell"><code>git clone https://github.com/mr-superonion/FPFS.git
cd FPFS
pip install -e .</code></pre>
<h2 id="demos">## Demos</h2>
<hr />
<h2 id="demos">Demos</h2>
<h3 id="isolated-galaxies">Isolated galaxies</h3>
<p><a
href="https://github.com/mr-superonion/FPFS/blob/master/notebook/demos/demo1.ipynb">demo1</a>
Expand All @@ -44,7 +45,8 @@ <h3 id="isolated-galaxies">Isolated galaxies</h3>
errors</em>.</p>
<h3 id="blended-galaxies">blended galaxies</h3>
<p>TBD</p>
<h2 id="reference">## Reference</h2>
<hr />
<h2 id="reference">Reference</h2>
<ul>
<li><a
href="https://ui.adsabs.harvard.edu/abs/2021arXiv211001214L/abstract">version
Expand All @@ -53,5 +55,6 @@ <h2 id="reference">## Reference</h2>
href="https://ui.adsabs.harvard.edu/abs/2018MNRAS.481.4445L/abstract">version
1.0</a></li>
</ul>
<hr />
</body>
</html>
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
----

## Installation
----

For stable version:
```shell
Expand All @@ -15,9 +14,10 @@ cd FPFS
pip install -e .
```

## Demos
----

## Demos

### Isolated galaxies
[demo1](https://github.com/mr-superonion/FPFS/blob/master/notebook/demos/demo1.ipynb)
simulates noisy galaxies with different SNRs and processes the galaxies with FPFS
Expand All @@ -31,8 +31,10 @@ estimates shear under a more realistic situation with *PSF errors*.
### blended galaxies
TBD

----

## Reference
----
+ [version 2.0](https://ui.adsabs.harvard.edu/abs/2021arXiv211001214L/abstract)
+ [version 1.0](https://ui.adsabs.harvard.edu/abs/2018MNRAS.481.4445L/abstract)

----

0 comments on commit 9980f6b

Please sign in to comment.