Skip to content

Commit 74c83fe

Browse files
Update documentation links in various places (#131)
* README: add rtd badge * update project URLs in various places * docs: update installation instructions
1 parent 10ad40d commit 74c83fe

File tree

3 files changed

+22
-6
lines changed

3 files changed

+22
-6
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Python utilities and extensions for the Omicron (C++) GW event trigger generator
22

33
This package augments the core functionality of the Omicron ETG by providing utilities for building an HTCondor workflow (DAG) to parallelise processing, including segment-selection logic, frame-file discovery, and post-processing.
44

5-
All credit for the actual Omicron algorithm goes to [Florent Robinet](//github.com/FlorentRobinet/), see [here](http://virgo.in2p3.fr/GWOLLUM/v2r2/index.html?Main) for more details.
5+
All credit for the actual Omicron algorithm goes to [Florent Robinet](//github.com/FlorentRobinet/), see [here](https://virgo.docs.ligo.org/virgoapp/Omicron/) for more details.
66

77
## Installation
88

@@ -29,6 +29,7 @@ conda install -c conda-forge pyomicron
2929

3030
[![Build status](https://github.com/gwpy/pyomicron/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/gwpy/pyomicron/actions/workflows/build.yml)
3131
[![codecov](https://codecov.io/gh/gwpy/pyomicron/branch/master/graph/badge.svg)](https://codecov.io/gh/gwpy/pyomicron)
32+
[![Documentation](https://readthedocs.org/projects/pyomicron/badge/?version=latest)](https://pyomicron.readthedocs.io/en/latest/?badge=latest)
3233

3334
## License
3435

docs/index.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,31 @@
66
Welcome to PyOmicron's documentation!
77
=====================================
88

9-
PyOmicron is a workflow generator and processor tool for the `Omicron gravitational-wave event trigger generator <http://virgo.in2p3.fr/GWOLLUM/v2r2/index.html?Main>`_. It was built chiefly to simplify the automatic processing hundreds of data channels recorded by the `Laser Interferometer Gravitational-wave Observatory (LIGO) <http://ligo.org>`_ detectors in order to characterise the instrumental and environmental noises impacting their sensitivity.
9+
PyOmicron is a workflow generator and processor tool for the `Omicron gravitational-wave event trigger generator <https://virgo.docs.ligo.org/virgoapp/Omicron/>`_. It was built chiefly to simplify the automatic processing hundreds of data channels recorded by the `Laser Interferometer Gravitational-wave Observatory (LIGO) <https://www.ligo.caltech.edu>`_ and `Virgo <https://www.ego-gw.it/>`_ detectors in order to characterise the instrumental and environmental noises impacting their sensitivity.
1010

1111
Installing PyOmicron
1212
--------------------
1313

14-
The easiest method to install PyOmicron is using `pip <https://pip.pypa.io/en/stable/>`_ directly from the `GitHub repository <https://github.com/ligovirgo/pyomicron.git>`_:
14+
Installation
15+
------------
1516

16-
.. code-block:: bash
17+
PyOmicron can be installed with `conda <https://conda.io`
18+
(or `Mamba <https://mamba.readthedocs.io/>`_):
1719

18-
$ pip install git+https://github.com/ligovirgo/pyomicron.git
20+
.. code-block:: shell
21+
22+
conda install -c conda-forge pyomicron
23+
24+
or `pip <https://pip.pypa.io>`_:
25+
26+
.. code-block:: shell
27+
28+
python -m pip install pyomicron
29+
30+
.. warning::
31+
32+
Omicron (the C++ application) cannot be installed with `pip`, so installing
33+
PyOmicron with `conda/mamba` is strongly encouraged.
1934

2035
Documentation
2136
-------------

omicron/io.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ def merge_root_files(inputfiles, outputfile,
6060
6161
Notes
6262
-----
63-
This method requires the `ROOT <https://root.cern.ch/pyroot>`_ package.
63+
This method requires the `ROOT <https://root.cern.ch/>`_ package.
6464
"""
6565
import ROOT
6666
chains = {}

0 commit comments

Comments
 (0)