docs

AstroJacobLi · Sep 7, 2019 · 48aaeb5 · 48aaeb5
1 parent ffc1699
commit 48aaeb5
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,7 @@
 # MRF: Multi-Resolution Filtering
 Multi-Resolution Filtering: a method for isolating faint, extended emission in [Dragonfly](http://dragonflytelescope.org) data and other low resolution images.
 
-<p align="center">
-  <img src="https://github.com/AstroJacobLi/mrf/blob/master/df-logo.png" width="40%">
-</p>
+![](https://github.com/AstroJacobLi/mrf/blob/master/df-logo.png)
 
 Documentation
 -------------
@@ -53,7 +51,7 @@ print(os.path.isfile(os.path.join(mrf.__path__[0], 'iraf/macosx/x_images.e')))
 ```
 `True` means you have installed `mrf` successfully! Bravo!
 
-`Python>=3` is needed, but you can try whether `mrf` still works under `python2`. Check out the dependence of `mrf` depends from `requirements.txt`.
+If you need to use ``lanczos`` or ``cubic`` interpolation, you must have [``galsim``](https://github.com/GalSim-developers/GalSim) installed. You will also need [``unagi``](https://github.com/dr-guangtou/unagi) to download HSC images. `Python>=3` is needed, but you can try whether `mrf` still works under `python2`. Check out the dependence of `mrf` depends from `requirements.txt`.
 
 Acknowledgement
 ---------------

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -15,7 +15,6 @@
 # sys.path.insert(0, os.path.abspath('../..'))
 
 # -- Project information -----------------------------------------------------
-#from mrf import __version__
 # contents of docs/conf.py
 from pkg_resources import get_distribution
 release = get_distribution('mrf').version
@@ -26,10 +25,6 @@
 copyright = '2019, Jiaxuan Li, Pieter van Dokkum'
 author = 'Jiaxuan Li, Pieter van Dokkum'
 
-# The full version, including alpha/beta/rc tags
-#release = __version__
-#version = __version__
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be

diff --git a/docs/source/guide/install.rst b/docs/source/guide/install.rst
@@ -1,6 +1,6 @@
 Installation
 ============
-``mrf`` is a Python package which also incorperates some ``iraf`` functions. You can download and install the package as follows.
+``mrf`` is a Python package which also incorperates some ``iraf`` functions. You can download and install the package as follows. If you need to use ``lanczos`` or ``cubic`` interpolation, you must have `galsim <https://github.com/GalSim-developers/GalSim>`_ installed. You will also need `unagi <https://github.com/dr-guangtou/unagi>`_ to download HSC images.
 
 Install from ``pip``
 ----------------------

diff --git a/requirements.txt b/requirements.txt
@@ -8,5 +8,4 @@ palettable
 shapely
 reproject>=0.5.1
 tqdm
-PyYAML
-mrf==1.0.1
+PyYAML
diff --git a/setup.py b/setup.py
@@ -32,7 +32,7 @@ def readme():
 	author_email='[email protected], [email protected]',
 	license='MIT',
 	packages=find_packages(),
-    package_data={'mrf': ['iraf/macosx/*']},
+    package_data={'mrf': ['iraf/macosx/*', '*.md', '*.txt', '*.yaml']},
 	install_requires=INSTALL_REQUIRES,
     include_package_data=True,
     zip_safe=False,
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,5 +8,4 @@ palettable @@
     shapely
     reproject>=0.5.1
     tqdm
-    PyYAML
-    mrf==1.0.1
+    PyYAML