===== Installation =====

=== Setting up a virtual environment (Optional) ===

While it is not strictly necessary, it reduces possible conflicts if one installs python packages that do not need to be avalable systemwide into local, virtual environments.
An easy option to setup such virtual environments is the [[https://docs.python.org/3/library/venv.html#module-venv|venv]] module.

  python3 -m venv /path/to/new/virtual/environment

This creates a local environment under /path/to/new/virtual/environment, which can be loaded via:
  source /path/to/new/virtual/environment/bin/activate

=== Cloning and installation ===

Either within your virtual environment or systemwide, the easiest way to install [[https://gwemlightcurves.github.io/|gwemlightcurve]] is it to run

  pip install git+https://github.com/mcoughlin/gwemlightcurves
  pip install healpy
  pip install lalsuite
  pip install ligo.skymap

This process can take a few minutes and ensured that also all relevant packages will be installed.
Furthermore, for this tutorial, you will need
  pip install jupyter notebook
and the packages python3-dev, python3-tk, which might not be installed by default on your machine.


=== Typical errors ===
Sometimes the automatic installation runs into problems, here is an (incomplete) list of problems:

1.) If you get an error like:
  error: invalid command 'bdist_wheel'

Then please run
  pip install wheel
 
2.) If you get the error message:
Then please run
  21 | #include "Python.h"
               ^~~~~~~~~  ERROR: Failed building wheel for sncosmo
Then you should run
  sudo apt-get install python3-dev