Skip to content

Commit e8eaca9

Browse files
committed
update readme
1 parent 8d12bca commit e8eaca9

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,39 @@ TolTECA Tutorials
44
This repository contains tutorials for TolTEC data analysis.
55

66
To see the tutorials rendered as static web pages, see the `TolTECA tutorials
7-
site <http://to.be.set>`_.
7+
site <https://toltec-astro.github.io/tolteca_tutorials/rst-tutorials/basic_obs_data.html>`_.
8+
9+
How to run
10+
----------
811

912
To run the tutorials interactively, you'll need to make sure you have `Jupyter
1013
notebook <http://jupyter.org/>`_ installed, then clone or download this
1114
repository. The notebook files themselves live in the ``tutorials`` directory
1215
of this repository, organized by the names of the tutorials.
1316

17+
The tutorials depends on TolTECA python packages and some other supporting
18+
packages. To install those packages, run the following (preferrably in a
19+
dedicated virtual environment):
20+
21+
.. code::
22+
23+
$ cd tolteca_tutorials
24+
$ pip install -r pip-requirements.txt
25+
26+
1427
You can also get started quickly using `Binder <http://mybinder.org>`_ to run the tutorials in
1528
your web browser within a remote server:
1629

1730
.. image:: http://mybinder.org/badge.svg
1831
:target: https://mybinder.org/v2/gh/astropy/astropy-tutorials/master?filepath=tutorials/notebooks
1932

2033

34+
Acknowledgement
35+
---------------
36+
2137
This repo makes use of the astropy-tutorials repo as the template.
2238

39+
2340
Contributing tutorial material
2441
------------------------------
2542

0 commit comments

Comments
 (0)