annular.install_tulipa
======================

.. py:module:: annular.install_tulipa


Attributes
----------

.. autoapisummary::

   annular.install_tulipa.logger


Functions
---------

.. autoapisummary::

   annular.install_tulipa.install_tulipa


Module Contents
---------------

.. py:data:: logger

.. py:function:: install_tulipa(workspace: pathlib.Path | str = './') -> None

   Install TulipaEnergyModel.jl by instantiating a Julia environment.

   This function creates a Julia Project.toml file in the specified workspace
   directory and runs `Pkg.instantiate()` to install all required Julia
   dependencies, including TulipaEnergyModel.jl.

   :param workspace: Path to the workspace directory where the Julia environment
                     will be created. Defaults to the current directory ("./").

   :returns: Path to the directory containing the instantiated Julia environment.

   :raises SystemExit: If Julia package instantiation fails.