update in README

mtakahiro · Jul 17, 2020 · fd1aeba · fd1aeba
1 parent e2365da
commit fd1aeba
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 16 deletions.
diff --git a/README.rst b/README.rst
@@ -10,48 +10,53 @@ version 1.2
 - Far IR data set can be fitted simultaneously with a simple gray body spectrum (to be implemented in future version).
 - Due to the complex nature of grism data and code, feel free to contact the author.
 - From v1.2, BPASS templates can also be used. Those who wish to try the functionality, please contact the author.
+
 ========================================================================================
 
 
 Demonstration
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~
 .. image:: ./sample.png
-- Fitting movie can be found `here <https://youtu.be/pdkA9Judd-M>`__.
-
 
+- Fitting movie can be found `here <https://youtu.be/pdkA9Judd-M>`__.
 
 Pre-requirement
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 - astropy
 - Pandas
-- multiprocessing
+- multiprocess
 - lmfit (no older than ver1.0.0)
 - emcee (no older than ver3.0.0)
 - corner
 - python-fsps (ver0.3.0)
 - fsps
 
-These packages will be installed if users create a new conda environment, by executing;
-
-.. code-block:: bash
 
-    conda create --name gsf_environment.yml
+To run stellar population model, users need to install `fsps <https://github.com/cconroy20/fsps>`__ by following their instruction.
 
 
 Installation & Documentation
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Required packages will be installed by;
+
+.. code-block:: bash
+
+    pip install -r requirements.txt 
+
+
+Or if users create a new conda environment, by executing;
+
 .. code-block:: bash
 
-    git clone https://github.com/mtakahiro/gsf
-    cd gsf
-    python setup.py install
+    conda create --name gsf_environment.yml
+
 
 
 Examples
 ~~~~~~~~
-Example data set is stored in ./gsf/examples/
+An example data set is stored in ./gsf/examples/
 
 .. code-block:: bash
 

diff --git a/gsf_environment.yml b/gsf_environment.yml
@@ -55,8 +55,7 @@ dependencies:
   - xz=5.2.5=h0b31af3_0
   - zlib=1.2.11=h0b31af3_1006
   - pip:
-    - cosmolopy==0.4
-    - fsps==0.3.0
-    - gsf==1.1.0
+    - fsps
+    - git+https://github.com/mtakahiro/gsf#1.2
 prefix: /Users/tmorishita/anaconda3/envs/gsf
 
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,8 @@
+astropy==4.0.1.post1
+pandas==1.0.3
+multiprocess
+lmfit==1.0.0
+emcee==3.0.2
+corner==2.0.1
+git+https://github.com/dfm/python-fsps
+git+https://github.com/mtakahiro/gsf#1.2