Installation#

This section guides you through the installation process for pyMultiFit. Whether you’re a user or a developer, follow the steps below to get started quickly.

pyMultiFit depends on a few core libraries to ensure smooth functionality:


Installation for Users#

If you are a user looking to install and use the library, follow these steps.

Using Pip with Virtual Environment#

  1. Create a virtual environment:

    python -m venv multifit-env
    
  2. Activate the virtual environment:

    • On Linux/macOS:

      source multifit-env/bin/activate
      
    • On Windows:

      .\multifit-env\Scripts\activate
      
  3. Install the library:

    pip install pymultifit
    
  4. Verify the installation:

    python -c "import pymultifit; print('pyMultiFit installed successfully!')"
    

Using Conda#

  1. Create a new Conda environment:

    conda create -n multifit python=3.10
    
  2. Activate the environment:

    conda activate multifit
    
  3. Install the library:

    pip install pymultifit
    
  4. Verify the installation:

    python -c "import pymultifit; print('pyMultiFit installed successfully!')"
    

Installation for Developers#

If you are a developer looking to contribute or set up the library for development purposes, follow these steps for a complete setup.

  1. Fork the repository: Visit the pyMultiFit repository and fork it to your GitHub account.

  2. Clone the repository:

    git clone https://github.com/<YOUR-USERNAME>/pyMultiFit.git
    
  3. Alternatively, download the ZIP archive from the main branch and extract it.

  4. Use pip with a virtual environment or conda to set up the development environment.

Using Pip with Virtual Environment#

  1. Create a virtual environment:

    python -m venv multifit-env
    
  2. Activate the virtual environment:

    • On Linux/macOS:

      source multifit-env/bin/activate
      
    • On Windows:

      .\multifit-env\Scripts\activate
      
  3. Install dependencies:

    Use the requirements[dev].txt file to completely install all dependencies at once:

    pip install -r requirements[dev].txt
    

Using Conda#

  1. Create a Conda environment:

    Use the environment.yml file in the repository:

    conda env create -f environment.yml
    
  2. Activate the Conda environment:

    conda activate multifit
    

Next Steps Now that you have installed pyMultiFit, head over to the Tutorials section to start exploring its features and capabilities.