Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
sergiopasra committed Jun 19, 2020
1 parent c2972a3 commit d660798
Showing 1 changed file with 23 additions and 79 deletions.
102 changes: 23 additions & 79 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,104 +2,48 @@
Numina
======

|zenodo| |docs| |pypi|

.. image:: https://travis-ci.org/guaix-ucm/numina.svg?branch=master
:target: https://travis-ci.org/guaix-ucm/numina

.. image:: https://coveralls.io/repos/guaix-ucm/numina/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/guaix-ucm/numina?branch=master
|zenodo| |docs| |pypi| |travis| |coveralls|

This is Numina, the data reduction package used by the following
Gran Telescopio Canarias instruments: EMIR, FRIDA, MEGARA and MIRADAS.

Numina is distributed under GNU GPL, either version 3 of the License,
or (at your option) any later version. See the file LICENSE.txt for
details.

Requirements
------------

Python 2.7 or 3.6 (or greater) is required. Numina requires the following
packages installed in order to work properly:
You can install numina using
the `released code in PyPI <https://pypi.org/project/numina/>`_ or
the `development version in Github <https://github.com/guaix-ucm/numina>`_.

- setuptools (http://pythonhosted.org/setuptools/)
- six >= 1.7 (https://pythonhosted.org/six/)
- numpy >= 1.6 (http://numpy.scipy.org/)
- scipy (http://www.scipy.org)
- astropy >= 2 (http://www.astropy.org/)
- PyYaml (http://pyyaml.org/)
- dateutil (https://pypi.org/project/python-dateutil/)
- lmfit (https://lmfit.github.io/lmfit-py/)
- scikit-image (https://scikit-image.org/)

The documentation of the project is generated using Sphinx (http://sphinx.pocoo.org/)

Additional packages are optionally required:
- sphinx (http://sphinx-doc.org) to build the documentation
- pytest (http://pytest.org) for testing
The installation instructions are available in the
`online documentation <https://numina.readthedocs.io/en/latest/user/install.html>`_
or `doc/user/install.rst <doc/user/install.rst>`_ in the source distribution.

Licensing
---------
Numina is distributed under GNU GPL, either version 3 of the License,
or (at your option) any later version. See the file LICENSE.txt for
details.

Authors
-------
Webpage: https://github.com/guaix-ucm/numina

Maintainers: Sergio Pascual sergiopr@fis.ucm.es, Nicolás Cardiel cardiel@ucm.es


Stable version
--------------

The latest stable version of Numina can be downloaded from
https://pypi.python.org/pypi/numina

To install numina, use the standard installation procedure:::

$ tar zxvf numina-X.Y.Z.tar.gz
$ cd numina-X.Y.Z
$ python setup.py install

The `install` command provides options to change the target directory. By default
installation requires administrative privileges. The different installation options
can be checked with:::

$ python setup.py install --help

Development version
-------------------

The development version can be checked out with:::

$ git clone https://github.com/guaix-ucm/numina.git

And then installed following the standard procedure:::

$ cd numina
$ python setup.py install

Building the documentation
--------------------------
The Numina documentation is based on `sphinx`_. With the package installed,
the html documentation can be built from the `doc` directory::

$ cd doc
$ make html
The documentation will be copied to a directory under `build/sphinx`.

The documentation can be built in different formats. The complete list will appear
if you type `make`

.. _virtualenv: http://pypi.python.org/pypi/virtualenv
.. _sphinx: http://sphinx.pocoo.org

.. |docs| image:: https://readthedocs.org/projects/numina/badge/?version=latest
:alt: Documentation Status
:target: http://numina.readthedocs.org/en/latest/?badge=latest

.. |zenodo| image:: https://zenodo.org/badge/doi/10.5281/zenodo.593638.svg
:target: https://doi.org/10.5281/zenodo.593638

:alt: Numina's Zenodo DOI

.. |pypi| image:: https://badge.fury.io/py/numina.svg
:target: https://badge.fury.io/py/numina
:alt: Numina's PyPI version

.. |travis| image:: https://img.shields.io/travis/guaix-ucm/numina/master?logo=travis%20ci&logoColor=white&label=Travis%20CI
:target: https://travis-ci.org/guaix-ucm/numina
:alt: Numina's Travis CI Status

.. |coveralls| image:: https://coveralls.io/repos/guaix-ucm/numina/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/guaix-ucm/numina?branch=master
:alt: Numina's Coverall Status

0 comments on commit d660798

Please sign in to comment.