1. Installation instructions
1.1. Dependencies
The fermihalos package requires the use of NumPy and SciPy for its correct functionality.
1.2. Installation
There are many ways to install fermihalos.
1.2.1. Using pip
To install fermihalos using the pip package manager simply run:
pip install fermihalos
which will install the package and its dependencies.
1.2.2. Using conda
To install fermihalos using the conda package manager simply run:
conda install fermihalos
which will install the package and its dependencies.
1.2.3. Using the setup.py
In case a manual installation is required, the first step is to clone the GitHub repository to the installation folder:
git clone https://github.com/Santiq22/FermiHalos.git
Then, since it is needed to have setuptools installed, it is recomended to have it updated. To do this, run:
python -m pip install --upgrade setuptools
Then, to install the package in your computer, run on the root directory of the cloned repository:
python setup.py install
This command will install the package and its required dependencies into the corresponding Python environment. The package will then be available for import and use. For more details on how to clone a GitHub repository or how to install a python package see Cloning a repository and Setuptools Documentation.