Installation
============

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

pymcfost requires:

- Python 3.6 or later
- numpy
- matplotlib
- astropy
- scipy
- progressbar2 (optional, for progress bars)
- mpl_scatter_density (optional, for density scatter plots)
- CASA (optional, for ALMA simulations)

Core Dependencies
~~~~~~~~~~~~~~~~~

.. code-block:: bash

   pip install numpy matplotlib astropy scipy

Optional Dependencies
~~~~~~~~~~~~~~~~~~~~~

For progress bars and scatter density plots:

.. code-block:: bash

   pip install progressbar2 mpl_scatter_density

Installing pymcfost
-------------------

The recommended way to install pymcfost is via pip:

.. code-block:: bash

   pip install pymcfost

Development Installation
------------------------

To install the development version from GitHub:

.. code-block:: bash

   git clone https://github.com/cpinte/pymcfost.git
   cd pymcfost
   pip install -e .

MCFOST Requirements
-------------------

To use pymcfost, you need to have MCFOST output files in your working directory:

- For images: ``RT.fits.gz`` or ``MC.fits.gz``
- For lines: ``lines.fits.gz``
- For SEDs: ``.sed_th.fits.gz``, ``sed_mc.fits.gz``, or ``sed_rt.fits.gz``
- For disc structure: ``grid.fits.gz``, ``gas_density.fits.gz``, ``volume.fits.gz``
- For dust models: ``lambda.fits.gz``, ``kappa.fits.gz``, ``albedo.fits.gz``, ``phase_function.fits.gz``

These files are generated by running the MCFOST radiative transfer code (not included with pymcfost).

CASA Requirements
-----------------

To use the CASA simulation functions (``CASA_simdata`` and ``pseudo_CASA_simdata``), you 
need to have CASA installed and accessible from the command line. 
The code has been tested with CASA 5.4.0-68 on MacOS.