Skip to content

Commit

Permalink
Update doc: not refering to a fixed python version
Browse files Browse the repository at this point in the history
  • Loading branch information
fschlueter committed Jan 23, 2024
1 parent 82ad9f1 commit 855d79b
Showing 1 changed file with 17 additions and 15 deletions.
32 changes: 17 additions & 15 deletions documentation/source/Introduction/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,11 @@ Installing NuRadioMC / NuRadioReco

Requirements
------------
In order to use ``NuRadioMC`` / ``NuRadioReco``, please ensure you are using a version of Python ``>=3.6``, and a UNIX operating system (linux or MacOS).
In order to use ``NuRadioMC`` / ``NuRadioReco``, please ensure you are using a `supported <https://devguide.python.org/versions/>`_ version of Python [#]_, and a UNIX operating system (linux or MacOS).
If you are using Windows, consider installing the `Windows Subsystem for Linux <https://docs.microsoft.com/en-us/windows/wsl/install>`_.

.. [#] We are doing our best effort to maintain compatibility across several python versions. However, issues might escape our radar. Please notify us on slack if you think there is an issue.
Installation using Pip
-------------------------
As of version ``2.0.0``, ``NuRadioReco`` is now a subpackage of ``NuRadioMC``. Both ``NuRadioMC`` and ``NuRadioReco`` can therefore be installed
Expand All @@ -16,26 +18,26 @@ using ``pip``:
pip install NuRadioMC
NuRadioMC/NuRadioReco will then be available from Python using ``import NuRadioMC`` and ``import NuRadioReco``, respectively.
The pip installation will also install all core dependencies.
The pip installation will also install all core dependencies.

.. Important::

Some optional dependencies cannot be installed using pip and
Some optional dependencies cannot be installed using pip and
:ref:`have to be installed manually <Introduction/pages/installation:Not pip-installable packages>`.

.. Note:: If you want the current version or you want to contribute to NuRadioReco, you need to install it manually.

Development version
---------------------------
The most recent version of ``NuRadioMC`` is available on `github <github.com>`_.
The most recent version of ``NuRadioMC`` is available on `github <github.com>`_.
It can be downloaded manually from the `repository website <https://github.com/nu-radio/NuRadioMC.git>`_,
or cloned using ``git``

.. code-block:: Bash
git clone https://github.com/nu-radio/NuRadioMC.git
If you don't already have it installed, you should `install Git <https://git-scm.com/>`_.
If you don't already have it installed, you should `install Git <https://git-scm.com/>`_.
To set up NuRadioMC and install the required dependencies, navigate to the ``NuRadioMC`` folder and run the python installer provided:

.. code-block:: bash
Expand All @@ -44,13 +46,13 @@ To set up NuRadioMC and install the required dependencies, navigate to the ``NuR
python3 install_dev.py
This will launch an interactive installer that allows you to install all core and some optional dependencies, as well as setting up some git settings
in case you want to contribute to NuRadioMC. **We highly recommend installing NuRadioMC inside a** `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_.
in case you want to contribute to NuRadioMC. **We highly recommend installing NuRadioMC inside a** `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_.
You can either use ``python3 -m venv name_of_venv``
or use a virtual environment manager like `conda <https://anaconda.org/anaconda/python>`_.
If you for some reason do not want to use a virtual environment, you can install the dependencies for the current user only by appending
or use a virtual environment manager like `conda <https://anaconda.org/anaconda/python>`_.
If you for some reason do not want to use a virtual environment, you can install the dependencies for the current user only by appending
``python3 install_dev.py --user``.

If the installer above does not work, or you want/need to install additional dependencies,
If the installer above does not work, or you want/need to install additional dependencies,
please follow the :ref:`manual installation instructions <Introduction/pages/installation:Manual installation>` below.

PYTHONPATH
Expand All @@ -76,17 +78,17 @@ To install all (optional and non-optional) dependencies available in pip at once
pip install numpy scipy matplotlib astropy tinydb tinydb-serialization aenum h5py mysql-python pymongo dash plotly toml peakutils
Note that some optional dependencies are not pip-installable and need to be
Note that some optional dependencies are not pip-installable and need to be
:ref:`installed manually <Introduction/pages/installation:Not pip-installable packages>`

Core Dependencies
^^^^^^^^^^^^^^^^^
- toml:

.. code-block:: bash
pip install toml
- radiotools:

.. code-block:: bash
Expand Down Expand Up @@ -196,7 +198,7 @@ These packages are recommended to be able to use all of NuRadioMC/NuRadioReco's
- conda cannot be used on all systems (eg. on Mac), in that case use a python venv, see details `here <https://github.com/tudo-astroparticlephysics/PROPOSAL/issues/209>`__

- if the linux kernel is too old (eg. on some computing clusters), refer to `this step-by-step guide <https://github.com/tudo-astroparticlephysics/PROPOSAL/wiki/Installing-PROPOSAL-on-a-Linux-kernel---4.11>`_


- To use the channelGalacticNoiseAdder, you need the `PyGDSM <https://github.com/telegraphic/pygdsm>`_ package.

Expand All @@ -207,8 +209,8 @@ These packages are recommended to be able to use all of NuRadioMC/NuRadioReco's
Not pip-installable packages
____________________________

- To speed up the :mod:`analytic ray tracing module <NuRadioMC.SignalProp.analyticraytracing>`, `GSL <https://www.gnu.org/software/gsl/>`_ needs
to be installed, and ``$GSL_DIR`` should point at the correct installation folder. On Linux, GSL can be installed using
- To speed up the :mod:`analytic ray tracing module <NuRadioMC.SignalProp.analyticraytracing>`, `GSL <https://www.gnu.org/software/gsl/>`_ needs
to be installed, and ``$GSL_DIR`` should point at the correct installation folder. On Linux, GSL can be installed using

.. code-block:: bash
Expand Down

0 comments on commit 855d79b

Please sign in to comment.